responses

Retrieve a response

Retrieve a stored response by ID.

get/v1/responses/{response_id}

Path parameters

response_idstring required

ID of the response

ID of the response

Query parameters

include[]string[] nullable

Additional response fields to include; unsupported values are ignored

Additional response fields to include; unsupported values are ignored

streamboolean

Replay the stored response as server-sent events

Replay the stored response as server-sent events

starting_afterinteger nullable

Sequence number the caller already received; the replay resumes after it and always ends with the terminal event

Sequence number the caller already received; the replay resumes after it and always ends with the terminal event

Response

The stored response or a replayed semantic event stream

idstring required
object'response'
created_atnumber required
status'completed' | 'failed' | 'in_progress' | 'cancelled' | 'queued' | 'incomplete' required
completed_atnumber nullable
instructionsstring nullable
modelstring
parallel_tool_callsboolean
temperaturenumber nullable
top_pnumber nullable
backgroundboolean
max_output_tokensinteger nullable
max_tool_callsinteger nullable
previous_response_idstring nullable
service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority'
truncation'auto' | 'disabled'
metadataobject nullable
safety_identifierstring nullable
prompt_cache_keystring nullable
userstring nullable
titlestring nullable

Example response

{
  "hosted_tools": [
    {
      "filters": {
        "all": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ],
        "any": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ],
        "none": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ]
      }
    }
  ]
}

Changes

Changed in 8 of the 18 revisions of this API.222930

  • eb12b76f5763132914See the full diff
    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • added the new context_window enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new max_tool_calls enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added to the / response property anyOf list for the response status

      response-property-any-of-added

    • the response's property default value changed from 10 to 5 for the status

      response-property-default-value-changed

    • the response's property default value changed from 30 to 10 for the status

      response-property-default-value-changed

    • the response's property default value changed from 5 to 8 for the status

      response-property-default-value-changed

    • response property hosted_tool_calls/items/oneOf[subschema #1: StoreSearchCallItem -> subschema #6: StoreSearchCallItem]/ deprecated

      response-property-deprecated

    • response property hosted_tool_calls/items/oneOf[subschema #2: StoreGrepCallItem -> subschema #7: StoreGrepCallItem]/ deprecated

      response-property-deprecated

    • response property hosted_tool_calls/items/oneOf[subschema #3: StoreListChunksCallItem -> subschema #8: StoreListChunksCallItem]/ deprecated

      response-property-deprecated

    • response property hosted_tool_calls/items/oneOf[subschema #4: MetadataFacetsCallItem -> subschema #9: MetadataFacetsCallItem]/ deprecated

      response-property-deprecated

    • response property hosted_tools/items/anyOf[subschema #1: StoreSearchTool -> subschema #6: StoreSearchTool]/ deprecated

      response-property-deprecated

    • response property hosted_tools/items/anyOf[subschema #2: StoreGrepTool -> subschema #7: StoreGrepTool]/ deprecated

      response-property-deprecated

    • response property hosted_tools/items/anyOf[subschema #3: StoreListChunksTool -> subschema #8: StoreListChunksTool]/ deprecated

      response-property-deprecated

    • response property hosted_tools/items/anyOf[subschema #4: MetadataFacetsTool -> subschema #9: MetadataFacetsTool]/ deprecated

      response-property-deprecated

    • added filter_chunks_call get_chunks_call grep_call inspect_metadata_call search_corpus_call discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ff7d87258f3211See the full diff
    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added reasoning sources discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added to the response property anyOf list for the response status

      response-property-any-of-added

    • added store_grep store_list_chunks store_metadata_facets discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • added store_grep_call store_list_chunks_call store_metadata_facets_call discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • mapped value for discriminator key store_search_call changed from to for / response property for the response status

      response-property-discriminator-mapping-changed

    • removed from the / response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property ////// to the response with the status

      response-optional-property-added

  • c6cc661737c357See the full diff
    • the response property /// became optional for the status

      response-property-became-optional

    • response property tools/items/oneOf[subschema #1: StoreSearchTool]/store_identifiers list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added to the ///// response property oneOf list for the response status

      response-property-one-of-added

    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added to the response property anyOf list for the response status

      response-property-any-of-added

    • added input_file input_image discriminator mapping keys to the ///// response property for the response status

      response-property-discriminator-mapping-added

    • added list_stores discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • added list_stores_call discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

    • endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog