Skip to main content
POST
/
v1
/
responses
Create Response
curl --request POST \
  --url http://localhost:8080/v1/responses \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "<string>",
  "input": "<string>",
  "fallbacks": [
    "<string>"
  ],
  "stream": true,
  "background": true,
  "conversation": "<string>",
  "include": [
    "<string>"
  ],
  "instructions": "<string>",
  "max_output_tokens": 123,
  "max_tool_calls": 123,
  "metadata": {},
  "parallel_tool_calls": true,
  "previous_response_id": "<string>",
  "prompt_cache_key": "<string>",
  "reasoning": {
    "effort": "<string>"
  },
  "safety_identifier": "<string>",
  "service_tier": "<string>",
  "stream_options": {
    "include_usage": true
  },
  "store": true,
  "temperature": 123,
  "text": {
    "max_tokens": 123
  },
  "top_logprobs": 123,
  "top_p": 123,
  "tool_choice": "auto",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "<string>",
        "arguments": {}
      }
    }
  ],
  "truncation": "<string>"
}'
{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "user",
        "content": "Hello, how are you?",
        "tool_call_id": "<string>",
        "tool_calls": [
          {
            "id": "tool_123",
            "type": "function",
            "function": {
              "name": "get_weather",
              "arguments": "{\"location\": \"San Francisco, CA\"}"
            }
          }
        ],
        "refusal": "<string>",
        "annotations": [
          {
            "type": "<string>",
            "url_citation": {
              "start_index": 123,
              "end_index": 123,
              "title": "<string>",
              "url": "<string>",
              "sources": "<any>",
              "type": "<string>"
            }
          }
        ],
        "thought": "<string>"
      },
      "finish_reason": "stop",
      "stop": "<string>",
      "log_probs": {
        "content": [
          {
            "bytes": [
              123
            ],
            "logprob": -0.123,
            "token": "hello",
            "top_logprobs": [
              {
                "bytes": [
                  123
                ],
                "logprob": -0.456,
                "token": "world"
              }
            ]
          }
        ],
        "refusal": [
          {
            "bytes": [
              123
            ],
            "logprob": -0.456,
            "token": "world"
          }
        ]
      }
    }
  ],
  "data": [
    {
      "index": 123,
      "object": "<string>",
      "embedding": [
        123
      ]
    }
  ],
  "speech": {
    "usage": {
      "characters": 123
    },
    "audio": "aSDinaTvuI8gbWludGxpZnk="
  },
  "transcribe": {
    "text": "<string>",
    "logprobs": [
      {
        "token": "<string>",
        "log_prob": 123
      }
    ],
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 123,
      "total_tokens": 123
    }
  },
  "messages": [
    {
      "role": "user",
      "content": "<string>"
    }
  ],
  "conversation_id": "<string>",
  "finish_reason": "<string>",
  "stop_reason": "<string>",
  "stop_sequence": "<string>",
  "prompt_cache": {
    "status": "<string>"
  },
  "model": "gpt-4o",
  "created": 1677652288,
  "service_tier": "<string>",
  "system_fingerprint": "<string>",
  "usage": {
    "prompt_tokens": 56,
    "completion_tokens": 31,
    "total_tokens": 87,
    "completion_tokens_details": {
      "reasoning_tokens": 123,
      "audio_tokens": 123,
      "accepted_prediction_tokens": 123,
      "rejected_prediction_tokens": 123
    }
  },
  "extra_fields": {
    "provider": "openai",
    "request_type": "list_models",
    "model_requested": "<string>",
    "model_params": {
      "temperature": 0.7,
      "top_p": 0.9,
      "top_k": 40,
      "max_tokens": 1000,
      "stop_sequences": [
        "\n\n",
        "END"
      ],
      "presence_penalty": 0,
      "frequency_penalty": 0,
      "tools": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "get_weather",
            "description": "Get current weather for a location",
            "parameters": {
              "type": "object",
              "description": "<string>",
              "properties": {},
              "required": [
                "<string>"
              ],
              "enum": [
                "<string>"
              ]
            }
          }
        }
      ],
      "tool_choice": {
        "type": "auto",
        "function": {
          "name": "get_weather"
        }
      },
      "parallel_tool_calls": true
    },
    "latency": 1234,
    "billed_usage": {
      "prompt_tokens": 123,
      "completion_tokens": 123,
      "search_units": 123,
      "classifications": 123
    },
    "raw_response": {}
  }
}

Body

application/json
​
model
string
required
​
input
required
​
fallbacks
string[]
​
stream
boolean
​
background
boolean
​
conversation
string
​
include
string[]
​
instructions
string
​
max_output_tokens
integer
​
max_tool_calls
integer
​
metadata
object
​
parallel_tool_calls
boolean
​
previous_response_id
string
​
prompt_cache_key
string
​
reasoning
object
​
safety_identifier
string
​
service_tier
string
​
stream_options
object
​
store
boolean
​
temperature
number
​
text
object
​
top_logprobs
integer
​
top_p
number
​
tool_choice
Available options:
auto,
any,
none,
required,
tool
​
tools
object[]
​
truncation
string

Response

​
id
string
Example:
​
object
enum<string>
Available options:
text.completion,
chat.completion,
embedding,
speech,
transcribe,
responses.completion
Example:
​
choices
object[]
​
data
object[]
​
speech
object
​
transcribe
object
​
messages
object[]
​
conversation_id
string
​
finish_reason
string
​
stop_reason
string
​
stop_sequence
string
​
prompt_cache
object
​
model
string
Example:
​
created
integer
Example:
​
service_tier
string
​
system_fingerprint
string
​
usage
object
​
extra_fields
object