{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenAI Assistants Realtime API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Realtime",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Realtime API call over WebRTC and receive the SDP answer needed\nto complete the peer connection.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/calls",
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Create a new Realtime API call over WebRTC and receive the SDP answer needed\nto complete the peer connection."
        },
        {
          "info": {
            "name": "Accept an incoming SIP call and configure the realtime session that will\nhandle it.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/calls/:call_id/accept",
            "params": [
              {
                "name": "call_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Accept an incoming SIP call and configure the realtime session that will\nhandle it."
        },
        {
          "info": {
            "name": "End an active Realtime API call, whether it was initiated over SIP or\nWebRTC.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/calls/:call_id/hangup",
            "params": [
              {
                "name": "call_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the call. For SIP calls, use the value provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook. For WebRTC sessions, reuse the call ID returned in the `Location`\nheader when creating the call with\n[`POST /v1/realtime/calls`](/docs/api-reference/realtime/create-call)."
              }
            ]
          },
          "docs": "End an active Realtime API call, whether it was initiated over SIP or\nWebRTC."
        },
        {
          "info": {
            "name": "Transfer an active SIP call to a new destination using the SIP REFER verb.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/calls/:call_id/refer",
            "params": [
              {
                "name": "call_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfer an active SIP call to a new destination using the SIP REFER verb."
        },
        {
          "info": {
            "name": "Decline an incoming SIP call by returning a SIP status code to the caller.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/calls/:call_id/reject",
            "params": [
              {
                "name": "call_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Decline an incoming SIP call by returning a SIP status code to the caller."
        },
        {
          "info": {
            "name": "Create a Realtime client secret with an associated session configuration.\n\nClient secrets are short-lived tokens that can be passed to a client app,\nsuch as a web frontend or mobile client, which grants access to the Realtime API without\nleaking your main API key. You can configure a custom TTL for each client secret.\n\nYou can also attach session configuration options to the client secret, which will be\napplied to any sessions created using that client secret, but these can also be overridden\nby the client connection.\n\n[Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).\n\nReturns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/client_secrets",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Realtime client secret with an associated session configuration.\n\nClient secrets are short-lived tokens that can be passed to a client app,\nsuch as a web frontend or mobile client, which grants access to the Realtime API without\nleaking your main API key. You can configure a custom TTL for each client secret.\n\nYou can also attach session configuration options to the client secret, which will be\napplied to any sessions created using that client secret, but these can also be overridden\nby"
        },
        {
          "info": {
            "name": "Create an ephemeral API token for use in client-side applications with the\nRealtime API. Can be configured with the same session parameters as the\n`session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime session object, plus an ephemeral key.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/sessions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an ephemeral API token for use in client-side applications with the\nRealtime API. Can be configured with the same session parameters as the\n`session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime session object, plus an ephemeral key.\n"
        },
        {
          "info": {
            "name": "Create an ephemeral API token for use in client-side applications with the\nRealtime API specifically for realtime transcriptions. \nCan be configured with the same session parameters as the `transcription_session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime transcription session object, plus an ephemeral key.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/transcription_sessions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an ephemeral API token for use in client-side applications with the\nRealtime API specifically for realtime transcriptions. \nCan be configured with the same session parameters as the `transcription_session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime transcription session object, plus an ephemeral key.\n"
        },
        {
          "info": {
            "name": "Create a Realtime translation client secret with an associated translation session configuration.\n\nClient secrets are short-lived tokens that can be passed to a client app,\nsuch as a web frontend or mobile client, which grants access to the Realtime\nTranslation API without leaking your main API key. You can configure a custom\nTTL for each client secret.\n\nReturns the created client secret and the effective translation session object.\nThe client secret is a string that looks like `ek_1234`.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/realtime/translations/client_secrets",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Realtime translation client secret with an associated translation session configuration.\n\nClient secrets are short-lived tokens that can be passed to a client app,\nsuch as a web frontend or mobile client, which grants access to the Realtime\nTranslation API without leaking your main API key. You can configure a custom\nTTL for each client secret.\n\nReturns the created client secret and the effective translation session object.\nThe client secret is a string that looks like `ek_1234`.\n"
        }
      ]
    }
  ],
  "bundled": true
}