{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenAI Assistants Responses API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Responses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Creates a model response. Provide [text](/docs/guides/text) or\n[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)\nor [JSON](/docs/guides/structured-outputs) outputs. Have the model call\nyour own [custom code](/docs/guides/function-calling) or use built-in\n[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)\nor [file search](/docs/guides/tools-file-search) to use your own data\nas input for the model's response.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/responses",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a model response. Provide [text](/docs/guides/text) or\n[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)\nor [JSON](/docs/guides/structured-outputs) outputs. Have the model call\nyour own [custom code](/docs/guides/function-calling) or use built-in\n[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)\nor [file search](/docs/guides/tools-file-search) to use your own data\nas input for the model's response.\n"
        },
        {
          "info": {
            "name": "Retrieves a model response with the given ID.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/responses/:response_id",
            "params": [
              {
                "name": "response_id",
                "value": "",
                "type": "path",
                "description": "The ID of the response to retrieve."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional fields to include in the response. See the `include`\nparameter for Response creation above for more information.\n"
              },
              {
                "name": "stream",
                "value": "",
                "type": "query",
                "description": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.\n"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "The sequence number of the event after which to start streaming.\n"
              },
              {
                "name": "include_obfuscation",
                "value": "",
                "type": "query",
                "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events\nto normalize payload sizes as a mitigation to certain side-channel\nattacks. These obfuscation fields are included by default, but add a\nsmall amount of overhead to the data stream. You can set\n`include_obfuscation` to false to optimize for bandwidth if you trust\nthe network links between your application and the OpenAI API.\n"
              }
            ]
          },
          "docs": "Retrieves a model response with the given ID.\n"
        },
        {
          "info": {
            "name": "Deletes a model response with the given ID.\n",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.openai.com/v1/responses/:response_id",
            "params": [
              {
                "name": "response_id",
                "value": "",
                "type": "path",
                "description": "The ID of the response to delete."
              }
            ]
          },
          "docs": "Deletes a model response with the given ID.\n"
        },
        {
          "info": {
            "name": "Cancels a model response with the given ID. Only responses created with\nthe `background` parameter set to `true` can be cancelled. \n[Learn more](/docs/guides/background).\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/responses/:response_id/cancel",
            "params": [
              {
                "name": "response_id",
                "value": "",
                "type": "path",
                "description": "The ID of the response to cancel."
              }
            ]
          },
          "docs": "Cancels a model response with the given ID. Only responses created with\nthe `background` parameter set to `true` can be cancelled. \n[Learn more](/docs/guides/background).\n"
        },
        {
          "info": {
            "name": "Returns a list of input items for a given response.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/responses/:response_id/input_items",
            "params": [
              {
                "name": "response_id",
                "value": "",
                "type": "path",
                "description": "The ID of the response to retrieve input items for."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.\n"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "An item ID to list items after, used in pagination.\n"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional fields to include in the response. See the `include`\nparameter for Response creation above for more information.\n"
              }
            ]
          },
          "docs": "Returns a list of input items for a given response."
        },
        {
          "info": {
            "name": "Returns input token counts of the request.\n\nReturns an object with `object` set to `response.input_tokens` and an `input_tokens` count.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/responses/input_tokens",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns input token counts of the request.\n\nReturns an object with `object` set to `response.input_tokens` and an `input_tokens` count."
        },
        {
          "info": {
            "name": "Compact a conversation. Returns a compacted response object.\n\nLearn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/responses/compact",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Compact a conversation. Returns a compacted response object.\n\nLearn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced)."
        }
      ]
    }
  ],
  "bundled": true
}