Справочник API

Responses API

Совместимый с OpenAI Responses API — преемник Chat Completions, со встроенными инструментами, такими как web search и file search. Используйте его через тот же endpoint и SDK.

Конечная точка

http
POST https://api.tokspan.com/v1/responses

Быстрые примеры

Responses API следует тем же паттернам OpenAI SDK — просто измените имя метода:

python
from openai import OpenAI

client = OpenAI(api_key="sk-your-key", base_url="https://api.tokspan.com/v1")

response = client.responses.create(
    model="MODEL_NAME",
    input="What is the capital of France?",
)

print(response.output_text)
shell
curl -X POST "https://api.tokspan.com/v1/responses" \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "input": "What is the capital of France?"
  }'
json — Response
{
  "id": "resp_abc123",
  "object": "response",
  "created_at": 1700000000,
  "status": "completed",
  "model": "MODEL_NAME",
  "output": [{
    "type": "message",
    "role": "assistant",
    "content": [{
      "type": "output_text",
      "text": "The capital of France is Paris.",
      "annotations": []
    }]
  }],
  "usage": {
    "input_tokens": 12,
    "output_tokens": 8,
    "total_tokens": 20
  }
}

Тело запроса

ПараметрТипОбязательныйОписание
modelstringДаID модели (например, gpt-4o, claude-opus-4-8). См. Модели для полного каталога.
inputstring / arrayДаВходные данные для ответа. Может быть простой строкой или массивом элементов сообщения (например, input_text, input_image).
instructionsstringНетИнструкции системного уровня для модели — эквивалент сообщения <code>system</code> в Responses API.
max_output_tokensintegerНетМаксимальное количество токенов для генерации в ответе.
temperaturenumberНетТемпература сэмплирования (0–2). Выше = более случайный результат.
streambooleanНетВключить потоковую передачу SSE. По умолчанию: false.
toolsarrayНетИнструменты, которые модель может вызывать, включая встроенные инструменты, такие как web_search_preview и file_search.
tool_choicestring / objectНетУправление выбором инструмента: "auto", "none", "required" или конкретный объект инструмента.
previous_response_idstringНетПередайте id предыдущего ответа, чтобы продолжить многоходовой диалог с сохранением состояния.
reasoningobjectНетКонфигурация рассуждения для reasoning-моделей (например, <code>effort</code>: <code>"low"</code> | <code>"medium"</code> | <code>"high"</code>).

Потоковая передача (SSE)

Установите stream: true, чтобы получать ответ инкрементально через Server-Sent Events — так же, как потоковая передача Chat Completions.

shell
curl -X POST "https://api.tokspan.com/v1/responses" \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "input": "Tell me a story.",
    "stream": true
  }'

Встроенные инструменты

Responses API поддерживает встроенные инструменты, не требующие пользовательских определений функций:

Web Search

json
{
  "model": "MODEL_NAME",
  "input": "What is the latest news about AI?",
  "tools": [{
    "type": "web_search_preview"
  }]
}

File Search

json
{
  "model": "MODEL_NAME",
  "input": "Summarize the Q3 report",
  "tools": [{
    "type": "file_search",
    "vector_store_ids": ["vs_abc123"]
  }]
}
Доступность встроенных инструментов: Web search и file search требуют upstream-моделей и каналов, которые их поддерживают. Доступность зависит от настроенных каналов в вашем бэкенде.