Documentation | Responses

API Reference

Responses

responses

Methods

Responses ->

Response

| { delta, sequence_number, type } | { sequence_number, type } | 52 more...

post/v5/responses

Responses

Response fields

Response

ResponseAudioDeltaEvent = { delta, sequence_number, type }

ResponseAudioDoneEvent = { sequence_number, type }

ResponseAudioTranscriptDeltaEvent = { delta, sequence_number, type }

ResponseAudioTranscriptDoneEvent = { sequence_number, type }

ResponseCodeInterpreterCallCodeDeltaEvent = { delta, item_id, output_index, 2 more... }

ResponseCodeInterpreterCallCodeDoneEvent = { code, item_id, output_index, 2 more... }

ResponseCodeInterpreterCallCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseCodeInterpreterCallInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseCodeInterpreterCallInterpretingEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseCompletedEvent = { response, sequence_number, type }

ResponseContentPartAddedEvent = { content_index, item_id, output_index, 3 more... }

ResponseContentPartDoneEvent = { content_index, item_id, output_index, 3 more... }

ResponseCreatedEvent = { response, sequence_number, type }

ResponseErrorEvent = { message, sequence_number, type, 2 more... }

ResponseFileSearchCallCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseFileSearchCallInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseFileSearchCallSearchingEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseFunctionCallArgumentsDeltaEvent = { delta, item_id, output_index, 2 more... }

ResponseFunctionCallArgumentsDoneEvent = { arguments, item_id, output_index, 2 more... }

ResponseInProgressEvent = { response, sequence_number, type }

ResponseFailedEvent = { response, sequence_number, type }

ResponseIncompleteEvent = { response, sequence_number, type }

ResponseOutputItemAddedEvent = { item, output_index, sequence_number, 1 more... }

ResponseOutputItemDoneEvent = { item, output_index, sequence_number, 1 more... }

ResponseReasoningSummaryPartAddedEvent = { item_id, output_index, part, 3 more... }

ResponseReasoningSummaryPartDoneEvent = { item_id, output_index, part, 3 more... }

ResponseReasoningSummaryTextDeltaEvent = { delta, item_id, output_index, 3 more... }

ResponseReasoningSummaryTextDoneEvent = { item_id, output_index, sequence_number, 3 more... }

ResponseReasoningTextDeltaEvent = { content_index, delta, item_id, 3 more... }

ResponseReasoningTextDoneEvent = { content_index, item_id, output_index, 3 more... }

ResponseRefusalDeltaEvent = { content_index, delta, item_id, 3 more... }

ResponseRefusalDoneEvent = { content_index, item_id, output_index, 3 more... }

ResponseTextDeltaEvent = { content_index, delta, item_id, 4 more... }

ResponseTextDoneEvent = { content_index, item_id, logprobs, 4 more... }

ResponseWebSearchCallCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseWebSearchCallInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseWebSearchCallSearchingEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseImageGenCallCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseImageGenCallGeneratingEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseImageGenCallInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseImageGenCallPartialImageEvent = { item_id, output_index, partial_image_b64, 3 more... }

ResponseMcpCallArgumentsDeltaEvent = { delta, item_id, output_index, 2 more... }

ResponseMcpCallArgumentsDoneEvent = { arguments, item_id, output_index, 2 more... }

ResponseMcpCallCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseMcpCallFailedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseMcpCallInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseMcpListToolsCompletedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseMcpListToolsFailedEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseMcpListToolsInProgressEvent = { item_id, output_index, sequence_number, 1 more... }

ResponseOutputTextAnnotationAddedEvent = { annotation, annotation_index, content_index, 4 more... }

ResponseQueuedEvent = { response, sequence_number, type }

ResponseCustomToolCallInputDeltaEvent = { delta, item_id, output_index, 2 more... }

ResponseCustomToolCallInputDoneEvent = { input, item_id, output_index, 2 more... }

GenericResponseEvent = { type }

Request example

curl https://api.egp.scale.com/v5/responses \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "input": "string",
          "model": "model"
        }'

200Example

{
  "id": "id",
  "created_at": 0,
  "model": "gpt-5",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "annotations": [
            {
              "file_id": "file_id",
              "filename": "filename",
              "index": 0,
              "type": "file_citation"
            }
          ],
          "text": "text",
          "type": "output_text",
          "logprobs": [
            {
              "token": "token",
              "bytes": [
                0
              ],
              "logprob": 0,
              "top_logprobs": [
                {
                  "token": "token",
                  "bytes": [
                    0
                  ],
                  "logprob": 0
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message"
    }
  ],
  "parallel_tool_calls": true,
  "tool_choice": "none",
  "tools": [
    {
      "name": "name",
      "type": "function",
      "description": "description",
      "parameters": {
        "foo": "bar"
      },
      "strict": true
    }
  ],
  "background": true,
  "error": {
    "code": "server_error",
    "message": "message"
  },
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "response",
  "previous_response_id": "previous_response_id",
  "prompt": {
    "id": "id",
    "variables": {
      "foo": "string"
    },
    "version": "version"
  },
  "prompt_cache_key": "prompt_cache_key",
  "reasoning": {
    "effort": "minimal",
    "generate_summary": "auto",
    "summary": "auto"
  },
  "safety_identifier": "safety_identifier",
  "service_tier": "auto",
  "status": "completed",
  "temperature": 0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "top_logprobs": 0,
  "top_p": 0,
  "truncation": "auto",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  },
  "user": "user"
}

Domain types

Response = { id, created_at, model, 26 more... }