logo

Alpha

Get Started

Introduction

Core Concepts

Utilities

Integrations

Introduction

This guide will get you started and make your first request to Interfaze. We support OpenAI's schema which includes compatibility with SDKs such as Vercel AI SDK, LangChain, OpenAI's SDK and more.

You can get started in 2 simple steps:

  1. Get your API key from the dashboard.
  2. Make your first query to https://api.interfaze.ai/v1 through the API or SDK of your choice.

OpenAI SDK

Vercel AI SDK (v5)

LangChain SDK

...

Files/Images

Both base64 and URL are natively supported for all file types.

Image URL

File URL

Base64 Image

Base64 File

...

System Messages

You can customize the behavior of the model using system messages. This is useful for setting the tone, style, or specific instructions for the model.

You can also add Guard Rails for content safety and moderation.

Basic System Message

Guardrails System Message

...

Streaming Responses

Interfaze supports streaming responses for real-time interactions. This is especially useful for long-form content generation or interactive applications.

OpenAI SDK

Vercel AI SDK (v5)

...