Responses format.

OpenAI Responses API-compatible endpoint, supporting single-turn/multi-turn input, tool calls, and reasoning parameters.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

ID of the model to invoke.

input*|array<>

Input content for the Responses API, either a string or an array of message objects.

instructions?string

System-level instructions for the model.

max_output_tokens?integer

Maximum number of tokens allowed in the generated response.

temperature?number

Sampling temperature; higher values produce more random output.

top_p?number

Nucleus sampling parameter that controls the cumulative probability range of candidate tokens.

stream?boolean

Whether to return the response as a stream.

tools?array<>

List of tool definitions available for the model to call.

tool_choice?|

Tool call strategy; can specify automatic selection or force a specific tool call.

reasoning?

Reasoning model configuration.

previous_response_id?string

Previous response ID, used to continue context.

truncation?string

Truncation strategy when input exceeds the context window.

Response Body

`application/json`

curl -X POST "https://example.com/v1/responses" \  -H "Content-Type: application/json" \  -d '{    "model": "gpt-5.4-nano",    "input": "Hello"  }'

{
  "id": "resp_123",
  "object": "response",
  "status": "string",
  "model": "string",
  "output": [
    {}
  ],
  "output_text": "string",
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "input_tokens": 0,
    "output_tokens": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}

Request Body

Response Body

200application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`