Skip to main content
POST

Authorizations

Authorization
string
header
required

Use Authorization: Bearer sk-... from https://omniall.ai/dashboard

Body

application/json

OpenAI Responses API request (POST /v1/responses). Prefer this for newer OpenAI models and built-in tools.

model
string
required

Model id from Model Square.

Example:

"gpt-5"

input

User input: a plain string, or an array of items/parts (input_text, input_image, input_file, etc.).

instructions
string

System-level instructions for this response (similar to a system prompt).

max_output_tokens
integer

Maximum tokens the model may generate.

temperature
number

Sampling temperature.

top_p
number

Nucleus sampling parameter.

stream
boolean

If true, stream response events over SSE.

stream_options
object

Streaming options passthrough.

tools
object[]

Built-in tools (e.g. { "type": "web_search_preview" }) and/or function tools for agents.

tool_choice

How tools are selected (auto, required, or specific tool).

parallel_tool_calls

Allow multiple tool calls in one turn when supported.

max_tool_calls
integer

Cap on tool calls for this response.

previous_response_id
string

Continue from a prior response id (multi-turn without resending full history).

conversation
object

Conversation object/id when using Responses conversation state.

reasoning
object

Reasoning controls for reasoning models.

text
object

Text format configuration (including structured output / json_schema when supported).

include
string[]

Extra fields to include in the response payload.

truncation
enum<string>

How to handle context overflow: auto or disabled.

Available options:
auto,
disabled
metadata
object

Arbitrary metadata attached to the response.

store

Whether upstream may store the interaction (channel setting dependent).

user
string

End-user identifier for abuse monitoring.

Response

Response object (or SSE events when streaming).

Responses API result object.

id
string

Response id (use with previous_response_id).

object
string

Usually response.

Example:

"response"

created_at
integer

Unix timestamp.

status
enum<string>

Lifecycle status: completed, failed, in_progress, incomplete.

Available options:
completed,
failed,
in_progress,
incomplete
model
string

Model used.

output
object[]

Output items (messages, tool calls, etc.). Read message content parts for the answer text.

usage
object

Token usage.