API reference
Responses API: scope and limits
POST /responses is stateless: every request carries its whole input. It supports text, image and PDF input and instructions, function and custom tools (including namespaced tools and client tool search), MCP tools, the web search tool, structured output and streaming.
- Endpoint
- POST https://api.vani.ai/v1/responses
- State
- Stateless: store false or omitted
- Output limit
- max_output_tokens (see Output limits)
- Streaming
- stream: true (Responses events)
On this pageSupported
Supported
- Text input (a string or message items with text parts) and
instructions; full history includingfunction_call,custom_tool_calland their outputs. input_image(for models that can see) andinput_file(a PDF infile_dataorfile_url) in user messages and function call outputs (see Images and PDFs on the API).- Function and custom tools,
tool_choice,parallel_tool_calls, namespaced tools and client-executed tool search (a tool markeddefer_loadingis offered at once). - Structured output:
text.formatof typejson_objectorjson_schema(name, schema up to 32 KiB,strict). The model is instructed to answer with JSON matching the schema; validate the result in your client. - MCP tools (see MCP tools on the API),
reasoning.effort,metadata,user,safety_identifier,prompt_cache_key,service_tierauto/default(orprioritywhere a fast model is listed). - The web search tool (
{"type": "web_search"}orweb_search_preview): Vani runs the searches and answers withweb_search_callitems andurl_citationannotations (see Web search and web fetch tools).
Not supported
- Stored state:
store: true,previous_response_id,conversationand background mode are refused, andGET /responses/{id}answers 404 because nothing is stored. Send the complete input on every call. - Hosted tools other than web search: file search, image generation and computer use. Use function tools, or the media endpoints for images.
- Audio input parts, and
file_idreferences (send images and PDFs inline or by URL). - Encrypted reasoning items in
input,top_logprobs,truncationother thandisabled,max_tool_callsandprompttemplates.
Note
unsupported Responses field: top_logprobs); nothing is billed.Note
include: ["reasoning.encrypted_content"] and reasoning.summary are accepted, because Codex sends them, but return nothing: no encrypted reasoning or reasoning summary is produced.More reference: OpenAI-compatible API · Anthropic-compatible API · Model ids, limits, headers and usage · Images and PDFs on the API · MCP tools on the API · Web search and web fetch tools · Media API: images and videos · Artifacts API · Model changes: webhooks, feeds and the changes API · API overview · Docs and quickstart