POST
/
v5
/
responses
Responses
curl --request POST \
  --url https://api.egp.scale.com/v5/responses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "include": [
    "<string>"
  ],
  "instructions": "<string>",
  "max_output_tokens": 123,
  "metadata": {},
  "parallel_tool_calls": true,
  "previous_response_id": "<string>",
  "reasoning": {},
  "store": true,
  "stream": true,
  "temperature": 1,
  "text": {},
  "tool_choice": "<string>",
  "tools": [
    {}
  ],
  "top_p": 0.5,
  "truncation": "auto",
  "model": "<string>",
  "input": "<string>"
}'
{
  "id": "<string>",
  "object": "response",
  "created_at": 123,
  "error": {
    "code": "server_error",
    "message": "<string>"
  },
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "instructions": "<string>",
  "metadata": {},
  "model": "<string>",
  "output": [
    {
      "id": "<string>",
      "content": [
        {
          "annotations": [
            {
              "file_id": "<string>",
              "filename": "<string>",
              "index": 123,
              "type": "file_citation"
            }
          ],
          "text": "<string>",
          "type": "output_text",
          "logprobs": [
            {
              "token": "<string>",
              "bytes": [
                123
              ],
              "logprob": 123,
              "top_logprobs": [
                {
                  "token": "<string>",
                  "bytes": [
                    123
                  ],
                  "logprob": 123
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message"
    }
  ],
  "parallel_tool_calls": true,
  "temperature": 123,
  "tool_choice": "none",
  "tools": [
    {
      "name": "<string>",
      "parameters": {},
      "strict": true,
      "type": "function",
      "description": "<string>"
    }
  ],
  "top_p": 123,
  "background": true,
  "max_output_tokens": 123,
  "max_tool_calls": 123,
  "previous_response_id": "<string>",
  "prompt": {
    "id": "<string>",
    "variables": {},
    "version": "<string>"
  },
  "prompt_cache_key": "<string>",
  "reasoning": {
    "effort": "minimal",
    "generate_summary": "auto",
    "summary": "auto"
  },
  "safety_identifier": "<string>",
  "service_tier": "auto",
  "status": "completed",
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "top_logprobs": 123,
  "truncation": "auto",
  "usage": {
    "input_tokens": 123,
    "input_tokens_details": {
      "cached_tokens": 123
    },
    "output_tokens": 123,
    "output_tokens_details": {
      "reasoning_tokens": 123
    },
    "total_tokens": 123
  },
  "user": "<string>"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.