Get Started
Developer Guide
- Supported Models
- Supported APIs
- Cost Tracking
MCP Registry and Gateway
- Introduction
- Getting Started
- MCP Server Authentication
- Agent API
- Example MCP Servers
Configure Gateway
- Access Control
- Rate Limiting
- Budget Limiting
- Load Balancing
- Fallback
- Guardrails and Security
Observability
Deployment
Agent Responses
Embeddings
Rerank
Responses
Audio
Moderations
Responses
Model Responses
Generate model responses using the specified model.
POST
/
responses
Model Responses
Copy
Ask AI
curl --request POST \
--url https://{controlPlaneURL}/api/llm/responses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "<string>",
"input": "<any>",
"background": true,
"include": [
"<string>"
],
"instructions": "<string>",
"max_output_tokens": 123,
"metadata": {},
"parallel_tool_calls": true,
"previous_response_id": "<string>",
"reasoning": {
"effort": "<string>"
},
"service_tier": "auto",
"store": true,
"stream": true,
"temperature": 123,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "none",
"tools": [
"<any>"
],
"top_p": 123,
"truncation": "auto",
"user": "<string>"
}'
Copy
Ask AI
{
"id": "<string>",
"object": "<string>",
"created_at": 123,
"status": "<string>",
"error": "<any>",
"incomplete_details": "<any>",
"instructions": "<any>",
"max_output_tokens": 123,
"model": "<string>",
"output": [
{
"id": "<string>",
"type": "<string>",
"status": "<string>",
"content": [
{
"type": "<string>",
"annotations": [
"<any>"
],
"text": "<string>"
}
],
"role": "<string>"
}
],
"parallel_tool_calls": true,
"previous_response_id": "<string>",
"reasoning": {
"effort": "<any>",
"summary": "<any>"
},
"service_tier": "<string>",
"store": true,
"temperature": 123,
"text": {
"format": {
"type": "<string>"
}
},
"tool_choice": "<string>",
"tools": [
"<any>"
],
"top_p": 123,
"truncation": "<string>",
"usage": {
"input_tokens": 123,
"input_tokens_details": {
"cached_tokens": 123
},
"output_tokens": 123,
"output_tokens_details": {
"reasoning_tokens": 123
},
"total_tokens": 123
},
"user": "<any>",
"metadata": {},
"provider": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Optional metadata for the request
Body
application/json
Parameters for generating model responses.
The body is of type object
.
Response
200
application/json
Model Response generated successfully.
The response is of type object
.
Was this page helpful?
Model Responses
Copy
Ask AI
curl --request POST \
--url https://{controlPlaneURL}/api/llm/responses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "<string>",
"input": "<any>",
"background": true,
"include": [
"<string>"
],
"instructions": "<string>",
"max_output_tokens": 123,
"metadata": {},
"parallel_tool_calls": true,
"previous_response_id": "<string>",
"reasoning": {
"effort": "<string>"
},
"service_tier": "auto",
"store": true,
"stream": true,
"temperature": 123,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "none",
"tools": [
"<any>"
],
"top_p": 123,
"truncation": "auto",
"user": "<string>"
}'
Copy
Ask AI
{
"id": "<string>",
"object": "<string>",
"created_at": 123,
"status": "<string>",
"error": "<any>",
"incomplete_details": "<any>",
"instructions": "<any>",
"max_output_tokens": 123,
"model": "<string>",
"output": [
{
"id": "<string>",
"type": "<string>",
"status": "<string>",
"content": [
{
"type": "<string>",
"annotations": [
"<any>"
],
"text": "<string>"
}
],
"role": "<string>"
}
],
"parallel_tool_calls": true,
"previous_response_id": "<string>",
"reasoning": {
"effort": "<any>",
"summary": "<any>"
},
"service_tier": "<string>",
"store": true,
"temperature": 123,
"text": {
"format": {
"type": "<string>"
}
},
"tool_choice": "<string>",
"tools": [
"<any>"
],
"top_p": 123,
"truncation": "<string>",
"usage": {
"input_tokens": 123,
"input_tokens_details": {
"cached_tokens": 123
},
"output_tokens": 123,
"output_tokens_details": {
"reasoning_tokens": 123
},
"total_tokens": 123
},
"user": "<any>",
"metadata": {},
"provider": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.