Create Responses Request (OpenAI)

curl --request POST \
  --url https://api.mixroute.ai/v1/responses \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-5.2",
    "max_output_tokens": 2048,
    "input": [
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
  }'

{
  "id": "resp_xxx",
  "object": "response",
  "created_at": 1768271369,
  "model": "gpt-5.2",
  "status": "completed",
  "output": [
    {
      "id": "msg_xxx",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Artificial Intelligence (AI) is a branch of computer science...",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 25,
    "output_tokens": 150,
    "total_tokens": 175
  }
}

POST

responses

curl --request POST \
  --url https://api.mixroute.ai/v1/responses \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-5.2",
    "max_output_tokens": 2048,
    "input": [
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
  }'

{
  "id": "resp_xxx",
  "object": "response",
  "created_at": 1768271369,
  "model": "gpt-5.2",
  "status": "completed",
  "output": [
    {
      "id": "msg_xxx",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Artificial Intelligence (AI) is a branch of computer science...",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 25,
    "output_tokens": 150,
    "total_tokens": 175
  }
}

Introduction

The Responses API is OpenAI’s next-generation conversation interface, specifically designed for reasoning models (o-series, GPT-5 series) and advanced features. Compared to the traditional Chat Completions API, the Responses API provides more precise reasoning control, built-in tool support, and multimodal input capabilities.

Use Cases

Reasoning-intensive tasks: Using reasoning models like o1, o3-mini, o4-mini, GPT-5
Web search requirements: Built-in Web Search Preview tool
Advanced tool calls: Support for Function Call and Custom Tool Call
Multi-turn conversation continuation: Conversation history management via previous_response_id

Authentication

Bearer Token, e.g., Bearer sk-xxxxxxxxxx

Request Parameters

model

string

required

Model identifier, e.g., gpt-5.2, o4-mini, o3-mini

input

array

required

Input message list

max_output_tokens

integer

Maximum output tokens

stream

boolean

Enable streaming output

reasoning

object

Reasoning configuration, e.g., {"effort": "high", "summary": "detailed"}

tools

array

Tool list, supports Web Search and function calls

previous_response_id

string

Previous response ID for conversation continuation

Basic Examples

Simple Conversation (Non-streaming)
Simple Conversation (Streaming)
Python SDK

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "max_output_tokens": 2048,
    "input": [
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
  }'

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "stream": true,
    "max_output_tokens": 2048,
    "input": [
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
  }'

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxxxx",
    base_url="https://api.mixroute.ai/v1"
)

# Non-streaming call
response = client.responses.create(
    model="gpt-5.2",
    max_output_tokens=2048,
    input=[
        {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
)

print(response.output[0].content[0].text)

# Streaming call
stream = client.responses.create(
    model="gpt-5.2",
    stream=True,
    max_output_tokens=2048,
    input=[
        {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
)

for event in stream:
    if event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)

Advanced Features

Web Search

Basic Example
Advanced Configuration

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "stream": true,
    "input": [
      {"role": "user", "content": "What are today'\''s news headlines?"}
    ],
    "tools": [
      {
        "type": "web_search_preview"
      }
    ]
  }'

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "stream": true,
    "input": [
      {"role": "user", "content": "Search for the latest AI research developments"}
    ],
    "tools": [
      {
        "type": "web_search_preview",
        "search_context_size": "high",
        "user_location": {
          "type": "approximate",
          "country": "US"
        }
      }
    ]
  }'

Configuration Options:

search_context_size: Search context size, options: low, medium, high
user_location: User location, affects regional relevance of search results

Reasoning Control

Auto Reasoning Summary
Detailed Reasoning Process

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "o4-mini",
    "stream": true,
    "reasoning": {
      "effort": "medium",
      "summary": "auto"
    },
    "max_output_tokens": 4096,
    "input": [
      {"role": "user", "content": "Calculate the sum of 1+2+3+...+100"}
    ]
  }'

Note: summary: "auto" automatically generates a reasoning summary, suitable for quick results.

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "o4-mini",
    "stream": true,
    "reasoning": {
      "effort": "high",
      "summary": "detailed"
    },
    "max_output_tokens": 8192,
    "input": [
      {"role": "user", "content": "Prove that the square root of 2 is irrational"}
    ]
  }'

Reasoning Configuration Parameters:

effort: Reasoning intensity, options: low, medium, high
summary: Summary mode, options: auto, concise, detailed

Custom Function Calls

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "input": [
      {"role": "user", "content": "What'\''s the weather like in New York today?"}
    ],
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_weather",
          "description": "Get weather information for a specified city",
          "parameters": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "description": "City name"
              },
              "unit": {
                "type": "string",
                "enum": ["celsius", "fahrenheit"],
                "description": "Temperature unit"
              }
            },
            "required": ["city"]
          }
        }
      }
    ],
    "tool_choice": "auto"
  }'

Multimodal Input

Image Input
File Input

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "What'\''s in this image?"
          },
          {
            "type": "input_image",
            "image_url": "https://api.mixroute.ai/demo/sample-image.jpg"
          }
        ]
      }
    ]
  }'

curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "Please summarize the main content of this document"
          },
          {
            "type": "input_file",
            "file_id": "file-xxxxxxxx"
          }
        ]
      }
    ]
  }'

Before using file input, you need to upload the file via the Files API to obtain a file_id.

Conversation Continuation

Use previous_response_id to maintain context across multi-turn conversations:

# First conversation turn
curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "input": [
      {"role": "user", "content": "My name is John, please remember my name"}
    ]
  }'

# Response returns id: "resp_abc123"

# Second conversation turn (continuing context)
curl -X POST "https://api.mixroute.ai/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-5.2",
    "previous_response_id": "resp_abc123",
    "input": [
      {"role": "user", "content": "What is my name?"}
    ]
  }'

Response Format

Non-streaming Response
Streaming Response (SSE Events)

{
  "id": "resp_xxx",
  "object": "response",
  "created_at": 1709123456,
  "model": "gpt-5.2",
  "status": "completed",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Artificial Intelligence (AI) is a branch of computer science..."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 25,
    "output_tokens": 150,
    "total_tokens": 175
  }
}

Streaming responses are returned in Server-Sent Events (SSE) format:

event: response.created
data: {"type":"response.created","response":{"id":"resp_xxx","status":"in_progress"}}

event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"type":"message","role":"assistant"}}

event: response.content_part.added
data: {"type":"response.content_part.added","part":{"type":"output_text","text":""}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"Artificial"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":" Intelligence"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":" is..."}

event: response.output_text.done
data: {"type":"response.output_text.done","text":"Artificial Intelligence is..."}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_xxx","status":"completed","usage":{"input_tokens":25,"output_tokens":150}}}

Common SSE Event Types:

Event Type	Description
`response.created`	Response created
`response.output_text.delta`	Text delta output
`response.output_text.done`	Text output complete
`response.completed`	Response completed
`response.failed`	Response failed

Comparison: Responses API vs Chat Completions API

Feature	Responses API	Chat Completions API
Reasoning Model Support	✅ Full support	⚠️ Limited support
Built-in Web Search	✅ Native support	❌ Not supported
Reasoning Control	✅ Fine-grained control	❌ Not supported
Conversation Continuation	✅ `previous_response_id`	❌ Manual management required
Multimodal Input	✅ Full support	✅ Supported
Use Cases	Reasoning, search, advanced features	General conversation

curl --request POST \
  --url https://api.mixroute.ai/v1/responses \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-5.2",
    "max_output_tokens": 2048,
    "input": [
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ]
  }'

{
  "id": "resp_xxx",
  "object": "response",
  "created_at": 1768271369,
  "model": "gpt-5.2",
  "status": "completed",
  "output": [
    {
      "id": "msg_xxx",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Artificial Intelligence (AI) is a branch of computer science...",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 25,
    "output_tokens": 150,
    "total_tokens": 175
  }
}

Chat Completions (OpenAI)Create Messages (Claude)

​Introduction

​Use Cases

​Authentication

​Request Parameters

​Basic Examples

​Advanced Features

​Web Search

​Reasoning Control

​Custom Function Calls

​Multimodal Input

​Conversation Continuation

​Response Format

​Comparison: Responses API vs Chat Completions API

Introduction

Use Cases

Authentication

Request Parameters

Basic Examples

Advanced Features

Web Search

Reasoning Control

Custom Function Calls

Multimodal Input

Conversation Continuation

Response Format

Comparison: Responses API vs Chat Completions API