API Overview

The Assisters API is fully compatible with the OpenAI API specification, making it easy to migrate existing applications or use familiar SDKs.

Base URL

All API requests should be made to:

https://api.assisters.dev/v1

Authentication

Authenticate using your API key in the Authorization header:

Authorization: Bearer ask_your_api_key_here

Request Format

All requests should:

• Use HTTPS
• Include Content-Type: application/json header
• Send JSON-encoded request bodies

curl https://api.assisters.dev/v1/chat/completions \
  -H "Authorization: Bearer ask_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "assisters-chat-v1",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Response Format

All responses are JSON-encoded and follow the OpenAI response format:

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1706745600,
  "model": "assisters-chat-v1",
  "choices": [...],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  }
}

Available Endpoints

Response Headers

Every response includes useful headers:

Rate Limits

Rate limits depend on your subscription tier:

When you hit a rate limit, you'll receive a 429 Too Many Requests response with a Retry-After header.

Streaming

For chat completions, you can enable streaming for real-time responses:

{
  "model": "assisters-chat-v1",
  "messages": [...],
  "stream": true
}

Streaming responses use Server-Sent Events (SSE):

data: {"id":"chatcmpl-abc","choices":[{"delta":{"content":"Hello"}}]}

data: {"id":"chatcmpl-abc","choices":[{"delta":{"content":" world"}}]}

data: [DONE]

Idempotency

For POST requests, you can include an Idempotency-Key header to safely retry failed requests:

curl https://api.assisters.dev/v1/chat/completions \
  -H "Authorization: Bearer ask_your_api_key" \
  -H "Idempotency-Key: unique-request-id-123" \
  -H "Content-Type: application/json" \
  -d '{...}'

SDKs

Use the official OpenAI SDK with our base URL:

from openai import OpenAI

client = OpenAI(
    api_key="ask_your_api_key",
    base_url="https://api.assisters.dev/v1"
)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'ask_your_api_key',
  baseURL: 'https://api.assisters.dev/v1'
});

Versioning

The API is currently at version v1. We follow semantic versioning and will communicate any breaking changes well in advance.