📝 OpenAI Realtime Transcription

\n Transcribe audio in real-time using OpenAI's Realtime API. \n View source\n

\n\n

\n Model\n \n

\n \n

\n Language\n \n

\n \n

\n VAD\n \n

\n \n

\n \n \n \n

\n\n \n\n \n\n",[],[197,276],["D",1756970443473],[229],[197],"ab3781ca-895f-11f0-a0eb-0224a6c84d84","tools-connectors-mcp.md","01991399-632f-7218-92fd-e39ef1fa5bc1","01991399-632f-7218-92fd-e5f5166295d1",["D",1756970443473],"Connectors and MCP servers\n\nBeta\n\n==================================\n\nUse connectors and remote MCP servers to give models new capabilities.\n\nIn addition to tools you make available to the model with [function calling](/docs/guides/function-calling), you can give models new capabilities using **connectors** and **remote MCP servers**. These tools give the model the ability to connect to and control external services when needed to respond to a user's prompt. These tool calls can either be allowed automatically, or restricted with explicit approval required by you as the developer.\n\n* **Connectors** are OpenAI-maintained MCP wrappers for popular services like Google Workspace or Dropbox, like the connectors available in [ChatGPT](https://chatgpt.com).\n* **Remote MCP servers** can be any server on the public Internet that implements a remote [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server.\n\nThis guide will show how to use both remote MCP servers and connectors to give the model access to new capabilities.\n\nQuickstart\n----------\n\nCheck out the examples below to see how remote MCP servers and connectors work through the [Responses API](/docs/api-reference/responses/create). Both connectors and remote MCP servers can be used with the `mcp` built-in tool type.\n\nUsing remote MCP servers\n\nRemote MCP servers require a `server_url`. Depending on the server, you may also need an OAuth `authorization` parameter containing an access token.\n\nUsing a remote MCP server in the Responses API\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"never\"\n }\n ],\n \"input\": \"Roll 2d4+1\"\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [\n {\n type: \"mcp\",\n server_label: \"dmcp\",\n server_description: \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n server_url: \"https://dmcp-server.deno.dev/sse\",\n require_approval: \"never\",\n },\n ],\n input: \"Roll 2d4+1\",\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[\n {\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"never\",\n },\n ],\n input=\"Roll 2d4+1\",\n)\n\nprint(resp.output_text)\n```\n\nIt is very important that developers trust any remote MCP server they use with the Responses API. A malicious server can exfiltrate sensitive data from anything that enters the model's context. Carefully review the **Risks and Safety** section below before using this tool.\n\nUsing connectors\n\nConnectors require a `connector_id` parameter, and an OAuth access token provided by your application in the `authorization` parameter.\n\nUsing connectors in the Responses API\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"Dropbox\",\n \"connector_id\": \"connector_dropbox\",\n \"authorization\": \"\",\n \"require_approval\": \"never\"\n }\n ],\n \"input\": \"Summarize the Q2 earnings report.\"\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [\n {\n type: \"mcp\",\n server_label: \"Dropbox\",\n connector_id: \"connector_dropbox\",\n authorization: \"\",\n require_approval: \"never\",\n },\n ],\n input: \"Summarize the Q2 earnings report.\",\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[\n {\n \"type\": \"mcp\",\n \"server_label\": \"Dropbox\",\n \"connector_id\": \"connector_dropbox\",\n \"authorization\": \"\",\n \"require_approval\": \"never\",\n },\n ],\n input=\"Summarize the Q2 earnings report.\",\n)\n\nprint(resp.output_text)\n```\n\nThe API will return new items in the `output` array of the model response. If the model decides to use a Connector or MCP server, it will first make a request to list available tools from the server, which will create a `mcp_list_tools` output item. From the simple remote MCP server example above, it contains only one tool definition:\n\n```json\n{\n \"id\": \"mcpl_68a6102a4968819c8177b05584dd627b0679e572a900e618\",\n \"type\": \"mcp_list_tools\",\n \"server_label\": \"dmcp\",\n \"tools\": [\n {\n \"annotations\": null,\n \"description\": \"Given a string of text describing a dice roll...\",\n \"input_schema\": {\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"diceRollExpression\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\"diceRollExpression\"],\n \"additionalProperties\": false\n },\n \"name\": \"roll\"\n }\n ]\n}\n```\n\nIf the model decides to call one of the available tools from the MCP server, you will also find a `mcp_call` output which will show what the model sent to the MCP tool, and what the MCP tool sent back as output.\n\n```json\n{\n \"id\": \"mcp_68a6102d8948819c9b1490d36d5ffa4a0679e572a900e618\",\n \"type\": \"mcp_call\",\n \"approval_request_id\": null,\n \"arguments\": \"{\\\"diceRollExpression\\\":\\\"2d4 + 1\\\"}\",\n \"error\": null,\n \"name\": \"roll\",\n \"output\": \"4\",\n \"server_label\": \"dmcp\"\n}\n```\n\nRead on in the guide below to learn more about how the MCP tool works, how to filter available tools, and how to handle tool call approval requests.\n\nHow it works\n------------\n\nThe MCP tool (for both remote MCP servers and connectors) is available in the [Responses API](/docs/api-reference/responses/create) in most recent models. Check MCP tool compatibility for your model [here](/docs/models). When you're using the MCP tool, you only pay for [tokens](/docs/pricing) used when importing tool definitions or making tool calls. There are no additional fees involved per tool call.\n\nBelow, we'll step through the process the API takes when calling an MCP tool.\n\n### Step 1: Listing available tools\n\nWhen you specify a remote MCP server in the `tools` parameter, the API will attempt to get a list of tools from the server. The Responses API works with remote MCP servers that support either the Streamable HTTP or the HTTP/SSE transport protocols.\n\nIf successful in retrieving the list of tools, a new `mcp_list_tools` output item will appear in the model response output. The `tools` property of this object will show the tools that were successfully imported.\n\n```json\n{\n \"id\": \"mcpl_68a6102a4968819c8177b05584dd627b0679e572a900e618\",\n \"type\": \"mcp_list_tools\",\n \"server_label\": \"dmcp\",\n \"tools\": [\n {\n \"annotations\": null,\n \"description\": \"Given a string of text describing a dice roll...\",\n \"input_schema\": {\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"diceRollExpression\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\"diceRollExpression\"],\n \"additionalProperties\": false\n },\n \"name\": \"roll\"\n }\n ]\n}\n```\n\nAs long as the `mcp_list_tools` item is present in the context of an API request, the API will not fetch a list of tools from the MCP server again at each turn in a [conversation](/docs/guides/conversation-state). We recommend you keep this item in the model's context as part of every conversation or workflow execution to optimize for latency.\n\n#### Filtering tools\n\nSome MCP servers can have dozens of tools, and exposing many tools to the model can result in high cost and latency. If you're only interested in a subset of tools an MCP server exposes, you can use the `allowed_tools` parameter to only import those tools.\n\nConstrain allowed tools\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"never\",\n \"allowed_tools\": [\"roll\"]\n }\n ],\n \"input\": \"Roll 2d4+1\"\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [{\n type: \"mcp\",\n server_label: \"dmcp\",\n server_description: \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n server_url: \"https://dmcp-server.deno.dev/sse\",\n require_approval: \"never\",\n allowed_tools: [\"roll\"],\n }],\n input: \"Roll 2d4+1\",\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[{\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"never\",\n \"allowed_tools\": [\"roll\"],\n }],\n input=\"Roll 2d4+1\",\n)\n\nprint(resp.output_text)\n```\n\n### Step 2: Calling tools\n\nOnce the model has access to these tool definitions, it may choose to call them depending on what's in the model's context. When the model decides to call an MCP tool, the API will make an request to the remote MCP server to call the tool and put its output into the model's context. This creates an `mcp_call` item which looks like this:\n\n```json\n{\n \"id\": \"mcp_68a6102d8948819c9b1490d36d5ffa4a0679e572a900e618\",\n \"type\": \"mcp_call\",\n \"approval_request_id\": null,\n \"arguments\": \"{\\\"diceRollExpression\\\":\\\"2d4 + 1\\\"}\",\n \"error\": null,\n \"name\": \"roll\",\n \"output\": \"4\",\n \"server_label\": \"dmcp\"\n}\n```\n\nThis item includes both the arguments the model decided to use for this tool call, and the `output` that the remote MCP server returned. All models can choose to make multiple MCP tool calls, so you may see several of these items generated in a single API request.\n\nFailed tool calls will populate the error field of this item with MCP protocol errors, MCP tool execution errors, or general connectivity errors. The MCP errors are documented in the MCP spec [here](https://modelcontextprotocol.io/specification/2025-03-26/server/tools#error-handling).\n\n#### Approvals\n\nBy default, OpenAI will request your approval before any data is shared with a connector or remote MCP server. Approvals help you maintain control and visibility over what data is being sent to an MCP server. We highly recommend that you carefully review (and optionally log) all data being shared with a remote MCP server. A request for an approval to make an MCP tool call creates a `mcp_approval_request` item in the Response's output that looks like this:\n\n```json\n{\n \"id\": \"mcpr_68a619e1d82c8190b50c1ccba7ad18ef0d2d23a86136d339\",\n \"type\": \"mcp_approval_request\",\n \"arguments\": \"{\\\"diceRollExpression\\\":\\\"2d4 + 1\\\"}\",\n \"name\": \"roll\",\n \"server_label\": \"dmcp\"\n}\n```\n\nYou can then respond to this by creating a new Response object and appending an `mcp_approval_response` item to it.\n\nApproving the use of tools in an API request\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"always\",\n }\n ],\n \"previous_response_id\": \"resp_682d498bdefc81918b4a6aa477bfafd904ad1e533afccbfa\",\n \"input\": [{\n \"type\": \"mcp_approval_response\",\n \"approve\": true,\n \"approval_request_id\": \"mcpr_682d498e3bd4819196a0ce1664f8e77b04ad1e533afccbfa\"\n }]\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [{\n type: \"mcp\",\n server_label: \"dmcp\",\n server_description: \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n server_url: \"https://dmcp-server.deno.dev/sse\",\n require_approval: \"always\",\n }],\n previous_response_id: \"resp_682d498bdefc81918b4a6aa477bfafd904ad1e533afccbfa\",\n input: [{\n type: \"mcp_approval_response\",\n approve: true,\n approval_request_id: \"mcpr_682d498e3bd4819196a0ce1664f8e77b04ad1e533afccbfa\"\n }],\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[{\n \"type\": \"mcp\",\n \"server_label\": \"dmcp\",\n \"server_description\": \"A Dungeons and Dragons MCP server to assist with dice rolling.\",\n \"server_url\": \"https://dmcp-server.deno.dev/sse\",\n \"require_approval\": \"always\",\n }],\n previous_response_id=\"resp_682d498bdefc81918b4a6aa477bfafd904ad1e533afccbfa\",\n input=[{\n \"type\": \"mcp_approval_response\",\n \"approve\": True,\n \"approval_request_id\": \"mcpr_682d498e3bd4819196a0ce1664f8e77b04ad1e533afccbfa\"\n }],\n)\n\nprint(resp.output_text)\n```\n\nHere we're using the `previous_response_id` parameter to chain this new Response, with the previous Response that generated the approval request. But you can also pass back the [outputs from one response, as inputs into another](/docs/guides/conversation-state#manually-manage-conversation-state) for maximum control over what enter's the model's context.\n\nIf and when you feel comfortable trusting a remote MCP server, you can choose to skip the approvals for reduced latency. To do this, you can set the `require_approval` parameter of the MCP tool to an object listing just the tools you'd like to skip approvals for like shown below, or set it to the value `'never'` to skip approvals for all tools in that remote MCP server.\n\nNever require approval for some tools\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"deepwiki\",\n \"server_url\": \"https://mcp.deepwiki.com/mcp\",\n \"require_approval\": {\n \"never\": {\n \"tool_names\": [\"ask_question\", \"read_wiki_structure\"]\n }\n }\n }\n ],\n \"input\": \"What transport protocols does the 2025-03-26 version of the MCP spec (modelcontextprotocol/modelcontextprotocol) support?\"\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [\n {\n type: \"mcp\",\n server_label: \"deepwiki\",\n server_url: \"https://mcp.deepwiki.com/mcp\",\n require_approval: {\n never: {\n tool_names: [\"ask_question\", \"read_wiki_structure\"]\n }\n }\n },\n ],\n input: \"What transport protocols does the 2025-03-26 version of the MCP spec (modelcontextprotocol/modelcontextprotocol) support?\",\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[\n {\n \"type\": \"mcp\",\n \"server_label\": \"deepwiki\",\n \"server_url\": \"https://mcp.deepwiki.com/mcp\",\n \"require_approval\": {\n \"never\": {\n \"tool_names\": [\"ask_question\", \"read_wiki_structure\"]\n }\n }\n },\n ],\n input=\"What transport protocols does the 2025-03-26 version of the MCP spec (modelcontextprotocol/modelcontextprotocol) support?\",\n)\n\nprint(resp.output_text)\n```\n\nAuthentication\n--------------\n\nUnlike the [example MCP server we used above](https://dash.deno.com/playground/dmcp-server), most other MCP servers require authentication. The most common scheme is an OAuth access token. Provide this token using the `authorization` field of the MCP tool:\n\nUse Stripe MCP tool\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5\",\n \"input\": \"Create a payment link for $20\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"stripe\",\n \"server_url\": \"https://mcp.stripe.com\",\n \"authorization\": \"$STRIPE_OAUTH_ACCESS_TOKEN\"\n }\n ]\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n input: \"Create a payment link for $20\",\n tools: [\n {\n type: \"mcp\",\n server_label: \"stripe\",\n server_url: \"https://mcp.stripe.com\",\n authorization: \"$STRIPE_OAUTH_ACCESS_TOKEN\"\n }\n ]\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n input=\"Create a payment link for $20\",\n tools=[\n {\n \"type\": \"mcp\",\n \"server_label\": \"stripe\",\n \"server_url\": \"https://mcp.stripe.com\",\n \"authorization\": \"$STRIPE_OAUTH_ACCESS_TOKEN\"\n }\n ]\n)\n\nprint(resp.output_text)\n```\n\nTo prevent the leakage of sensitive tokens, the Responses API does not store the value you provide in the `authorization` field. This value will also not be visible in the Response object created. Additionally, because some remote MCP servers generate authenticated URLs, we also discard the _path_ portion of the `server_url` in our responses (i.e. `example.com/mcp` becomes `example.com`). Because of this, you must send the full path of the MCP `server_url` and the `authorization` value in every Responses API creation request you make.\n\nConnectors\n----------\n\nThe Responses API has built-in support for a limited set of connectors to third-party services. These connectors let you pull in context from popular applications, like Dropbox and Gmail, to allow the model to interact with popular services.\n\nConnectors can be used in the same way as remote MCP servers. Both let an OpenAI model access additional third-party tools in an API request. However, instead of passing a `server_url` as you would to call a remote MCP server, you pass a `connector_id` which uniquely identifies a connector available in the API.\n\n### Available connectors\n\n* Dropbox: `connector_dropbox`\n* Gmail: `connector_gmail`\n* Google Calendar: `connector_googlecalendar`\n* Google Drive: `connector_googledrive`\n* Microsoft Teams: `connector_microsoftteams`\n* Outlook Calendar: `connector_outlookcalendar`\n* Outlook Email: `connector_outlookemail`\n* SharePoint: `connector_sharepoint`\n\nWe prioritized services that don't have official remote MCP servers. GitHub, for instance, has an official MCP server you can connect to by passing `https://api.githubcopilot.com/mcp/` to the `server_url` field in the MCP tool.\n\n### Authorizing a connector\n\nIn the `authorization` field, pass in an OAuth access token. OAuth client registration and authorization must be handled separately by your application.\n\nFor testing purposes, you can use Google's [OAuth 2.0 Playground](https://developers.google.com/oauthplayground/) to generate temporary access tokens that you can use in an API request.\n\nTo use the playground to test the connectors API functionality, start by entering:\n\n```text\nhttps://www.googleapis.com/auth/calendar.events\n```\n\nThis authorization scope will enable the API to read Google Calendar events. In the UI under \"Step 1: Select and authorize APIs\".\n\nAfter authorizing the application with your Google account, you will come to \"Step 2: Exchange authorization code for tokens\". This will generate an access token you can use in an API request using the Google Calendar connector:\n\nUse the Google Calendar connector\n\n```bash\ncurl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5\",\n \"tools\": [\n {\n \"type\": \"mcp\",\n \"server_label\": \"google_calendar\",\n \"connector_id\": \"connector_googlecalendar\",\n \"authorization\": \"ya29.A0AS3H6...\",\n \"require_approval\": \"never\"\n }\n ],\n \"input\": \"What is on my Google Calendar for today?\"\n }'\n```\n\n```javascript\nimport OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst resp = await client.responses.create({\n model: \"gpt-5\",\n tools: [\n {\n type: \"mcp\",\n server_label: \"google_calendar\",\n connector_id: \"connector_googlecalendar\",\n authorization: \"ya29.A0AS3H6...\",\n require_approval: \"never\",\n },\n ],\n input: \"What's on my Google Calendar for today?\",\n});\n\nconsole.log(resp.output_text);\n```\n\n```python\nfrom openai import OpenAI\n\nclient = OpenAI()\n\nresp = client.responses.create(\n model=\"gpt-5\",\n tools=[\n {\n \"type\": \"mcp\",\n \"server_label\": \"google_calendar\",\n \"connector_id\": \"connector_googlecalendar\",\n \"authorization\": \"ya29.A0AS3H6...\",\n \"require_approval\": \"never\",\n },\n ],\n input=\"What's on my Google Calendar for today?\",\n)\n\nprint(resp.output_text)\n```\n\nAn MCP tool call from a Connector will look the same as an MCP tool call from a remote MCP server, using the `mcp_call` output item type. In this case, both the arguments to and the response from the Connector are JSON strings:\n\n```json\n{\n \"id\": \"mcp_68a62ae1c93c81a2b98c29340aa3ed8800e9b63986850588\",\n \"type\": \"mcp_call\",\n \"approval_request_id\": null,\n \"arguments\": \"{\\\"time_min\\\":\\\"2025-08-20T00:00:00\\\",\\\"time_max\\\":\\\"2025-08-21T00:00:00\\\",\\\"timezone_str\\\":null,\\\"max_results\\\":50,\\\"query\\\":null,\\\"calendar_id\\\":null,\\\"next_page_token\\\":null}\",\n \"error\": null,\n \"name\": \"search_events\",\n \"output\": \"{\\\"events\\\": [{\\\"id\\\": \\\"2n8ni54ani58pc3ii6soelupcs_20250820\\\", \\\"summary\\\": \\\"Home\\\", \\\"location\\\": null, \\\"start\\\": \\\"2025-08-20T00:00:00\\\", \\\"end\\\": \\\"2025-08-21T00:00:00\\\", \\\"url\\\": \\\"https://www.google.com/calendar/event?eid=Mm44bmk1NGFuaTU4cGMzaWk2c29lbHVwY3NfMjAyNTA4MjAga3doaW5uZXJ5QG9wZW5haS5jb20&ctz=America/Los_Angeles\\\", \\\"description\\\": \\\"\\\\n\\\\n\\\", \\\"transparency\\\": \\\"transparent\\\", \\\"display_url\\\": \\\"https://www.google.com/calendar/event?eid=Mm44bmk1NGFuaTU4cGMzaWk2c29lbHVwY3NfMjAyNTA4MjAga3doaW5uZXJ5QG9wZW5haS5jb20&ctz=America/Los_Angeles\\\", \\\"display_title\\\": \\\"Home\\\"}], \\\"next_page_token\\\": null}\",\n \"server_label\": \"Google_Calendar\"\n}\n```\n\n### Available tools in each connector\n\nThe available tools depend on which scopes your OAuth token has available to it. Expand the tables below to see what tools you can use when connecting to each application.\n\nDropbox\n\n||\n|search|Search Dropbox for files that match a query|files.metadata.read, account_info.read|\n|fetch|Fetch a file by path with optional raw download|files.content.read|\n|search_files|Search Dropbox files and return results|files.metadata.read, account_info.read|\n|fetch_file|Retrieve a file's text or raw content|files.content.read, account_info.read|\n|list_recent_files|Return the most recently modified files accessible to the user|files.metadata.read, account_info.read|\n|get_profile|Retrieve the Dropbox profile of the current user|account_info.read|\n\nGmail\n\n||\n|get_profile|Return the current Gmail user's profile|userinfo.email, userinfo.profile|\n|search_emails|Search Gmail for emails matching a query or label|gmail.modify|\n|search_email_ids|Retrieve Gmail message IDs matching a search|gmail.modify|\n|get_recent_emails|Return the most recently received Gmail messages|gmail.modify|\n|read_email|Fetch a single Gmail message including its body|gmail.modify|\n|batch_read_email|Read multiple Gmail messages in one call|gmail.modify|\n\nGoogle Calendar\n\n||\n|get_profile|Return the current Calendar user's profile|userinfo.email, userinfo.profile|\n|search|Search Calendar events within an optional time window|calendar.events|\n|fetch|Get details for a single Calendar event|calendar.events|\n|search_events|Look up Calendar events using filters|calendar.events|\n|read_event|Read a Google Calendar event by ID|calendar.events|\n\nGoogle Drive\n\n||\n|get_profile|Return the current Drive user's profile|userinfo.email, userinfo.profile|\n|list_drives|List shared drives accessible to the user|drive.readonly|\n|search|Search Drive files using a query|drive.readonly|\n|recent_documents|Return the most recently modified documents|drive.readonly|\n|fetch|Download the content of a Drive file|drive.readonly|\n\nMicrosoft Teams\n\n||\n|search|Search Microsoft Teams chats and channel messages|Chat.Read, ChannelMessage.Read.All|\n|fetch|Fetch a Teams message by path|Chat.Read, ChannelMessage.Read.All|\n|get_chat_members|List the members of a Teams chat|Chat.Read|\n|get_profile|Return the authenticated Teams user's profile|User.Read|\n\nOutlook Calendar\n\n||\n|search_events|Search Outlook Calendar events with date filters|Calendars.Read|\n|fetch_event|Retrieve details for a single event|Calendars.Read|\n|fetch_events_batch|Retrieve multiple events in one call|Calendars.Read|\n|list_events|List calendar events within a date range|Calendars.Read|\n|get_profile|Retrieve the current user's profile|User.Read|\n\nOutlook Email\n\n||\n|get_profile|Return profile info for the Outlook account|User.Read|\n|list_messages|Retrieve Outlook emails from a folder|Mail.Read|\n|search_messages|Search Outlook emails with optional filters|Mail.Read|\n|get_recent_emails|Return the most recently received emails|Mail.Read|\n|fetch_message|Fetch a single email by ID|Mail.Read|\n|fetch_messages_batch|Retrieve multiple emails in one request|Mail.Read|\n\nSharepoint\n\n||\n|get_site|Resolve a SharePoint site by hostname and path|Sites.Read.All|\n|search|Search SharePoint/OneDrive documents by keyword|Sites.Read.All, Files.Read.All|\n|list_recent_documents|Return recently accessed documents|Files.Read.All|\n|fetch|Fetch content from a Graph file download URL|Files.Read.All|\n|get_profile|Retrieve the current user's profile|User.Read|\n\nRisks and safety\n----------------\n\nThe MCP tool permits you to connect OpenAI models to external services. This is a powerful feature that comes with some risks.\n\nFor connectors, there is a risk of potentially sending sensitive data to OpenAI, or allowing models read access to potentially sensitive data in those services.\n\nRemote MCP servers carry those same risks, but also have not been verified by OpenAI. These servers can allow models to access, send, and receive data, and take action in these services. All MCP servers are third-party services that are subject to their own terms and conditions.\n\nIf you come across a malicious MCP server, please report it to `security@openai.com`.\n\nBelow are some best practices to consider when integrating connectors and remote MCP servers.\n\n#### Prompt injection\n\n[Prompt injection](https://chatgpt.com/?prompt=what%20is%20prompt%20injection?) is an important security consideration in any LLM application, and is especially true when you give the model access to MCP servers and connectors which can access sensitive data or take action. Use these tools with appropriate caution and mitigations if the prompt for the model contains user-provided content.\n\n#### Always require approval for sensitive actions\n\nUse the available configurations of the `require_approval` and `allowed_tools` parameters to ensure that any sensitive actions require an approval flow.\n\n#### URLs within MCP tool calls and outputs\n\nIt can be dangerous to request URLs or embed image URLs provided by tool call outputs either from connectors or remote MCP servers. Ensure that you trust the domains and services providing those URLs before embedding or otherwise using them in your application code.\n\n#### Connecting to trusted servers\n\nPick official servers hosted by the service providers themselves (e.g. we recommend connecting to the Stripe server hosted by Stripe themselves on mcp.stripe.com, instead of a Stripe MCP server hosted by a third party). Because there aren't too many official remote MCP servers today, you may be tempted to use a MCP server hosted by an organization that doesn't operate that server and simply proxies request to that service via your API. If you must do this, be extra careful in doing your due diligence on these \"aggregators\", and carefully review how they use your data.\n\n#### Log and review data being shared with third party MCP servers.\n\nBecause MCP servers define their own tool definitions, they may request for data that you may not always be comfortable sharing with the host of that MCP server. Because of this, the MCP tool in the Responses API defaults to requiring approvals of each MCP tool call being made. When developing your application, review the type of data being shared with these MCP servers carefully and robustly. Once you gain confidence in your trust of this MCP server, you can skip these approvals for more performant execution.\n\nWe also recommend logging any data sent to MCP servers. If you're using the Responses API with `store=true`, these data are already logged via the API for 30 days unless Zero Data Retention is enabled for your organization. You may also want to log these data in your own systems and perform periodic reviews on this to ensure data is being shared per your expectations.\n\nMalicious MCP servers may include hidden instructions (prompt injections) designed to make OpenAI models behave unexpectedly. While OpenAI has implemented built-in safeguards to help detect and block these threats, it's essential to carefully review inputs and outputs, and ensure connections are established only with trusted servers.\n\nMCP servers may update tool behavior unexpectedly, potentially leading to unintended or malicious behavior.\n\n#### Implications on Zero Data Retention and Data Residency\n\nThe MCP tool is compatible with Zero Data Retention and Data Residency, but it's important to note that MCP servers are third-party services, and data sent to an MCP server is subject to their data retention and data residency policies.\n\nIn other words, if you're an organization with Data Residency in Europe, OpenAI will limit inference and storage of Customer Content to take place in Europe up until the point communication or data is sent to the MCP server. It is your responsibility to ensure that the MCP server also adheres to any Zero Data Retention or Data Residency requirements you may have. Learn more about Zero Data Retention and Data Residency [here](/docs/guides/your-data).\n\nUsage notes\n-----------\n\n||\n|ResponsesChat CompletionsAssistants|Tier 1200 RPMTier 2 and 31000 RPMTier 4 and 52000 RPM|PricingZDR and data residency|\n\nWas this page useful?",[],[202,294,287],"guides","ab377d06-895f-11f0-a0eb-0224a6c84d84","realtime.md","01991399-632f-7218-92fd-df72c5692067",["D",1756970443473],"Realtime API\n============\n\nBuild low-latency, multimodal LLM applications with the Realtime API.\n\nThe OpenAI Realtime API enables low-latency communication with [models](/docs/models) that natively support speech-to-speech interactions as well as multimodal inputs (audio, images, and text) and outputs (audio and text). These APIs can also be used for [realtime audio transcription](/docs/guides/realtime-transcription).\n\nVoice agents\n------------\n\nOne of the most common use cases for the Realtime API is building voice agents for speech-to-speech model interactions in the browser. Our recommended starting point for these types of applications is the [Agents SDK for TypeScript](https://openai.github.io/openai-agents-js/guides/voice-agents/), which uses a [WebRTC connection](/docs/guides/realtime-webrtc) to the Realtime model in the browser, and [WebSocket](/docs/guides/realtime-websocket) when used on the server.\n\n```js\nimport { RealtimeAgent, RealtimeSession } from \"@openai/agents/realtime\";\n\nconst agent = new RealtimeAgent({\n name: \"Assistant\",\n instructions: \"You are a helpful assistant.\",\n});\n\nconst session = new RealtimeSession(agent);\n\n// Automatically connects your microphone and audio output\nawait session.connect({\n apiKey: \"\",\n});\n```\n\n[\n\nVoice Agent Quickstart\n\nFollow the voice agent quickstart to build Realtime agents in the browser.\n\n](https://openai.github.io/openai-agents-js/guides/voice-agents/quickstart/)\n\nTo use the Realtime API directly outside the context of voice agents, check out the other connection options below.\n\nConnection methods\n------------------\n\nWhile building [voice agents with the Agents SDK](https://openai.github.io/openai-agents-js/guides/voice-agents/) is the fastest path to one specific type of application, the Realtime API provides an entire suite of flexible tools for a variety of use cases.\n\nThere are three primary supported interfaces for the Realtime API:\n\n[\n\nWebRTC connection\n\nIdeal for browser and client-side interactions with a Realtime model.\n\n](/docs/guides/realtime-webrtc)[\n\nWebSocket connection\n\nIdeal for middle tier server-side applications with consistent low-latency network connections.\n\n](/docs/guides/realtime-websocket)[\n\nSIP connection\n\nIdeal for VoIP telephony connections.\n\n](/docs/guides/realtime-sip)\n\nDepending on how you'd like to connect to a Realtime model, check out one of the connection guides above to get started. You'll learn how to initialize a Realtime session, and how to interact with a Realtime model using client and server events.\n\nAPI Usage\n---------\n\nOnce connected to a realtime model using one of the methods above, learn how to interact with the model in these usage guides.\n\n* **[Prompting guide](/docs/guides/realtime-models-prompting):** learn tips and best practices for prompting and steering Realtime models.\n* **[Inputs and outputs](/docs/guides/realtime-inputs-outputs):** Learn how to pass audio, text, and image inputs to the model, and how to receive audio and text back.\n* **[Managing conversations](/docs/guides/realtime-conversations):** Learn about the Realtime session lifecycle and the key events that happen during a conversation.\n* **[Webhooks and server-side controls](/docs/guides/realtime-server-controls):** Learn how you can control a Realtime session on the server to call tools and implement guardrails.\n* **[Function calling](/docs/guides/realtime-function-calling):** Give the realtime model access to call custom code in your own application when appropriate.\n* **[MCP servers](/docs/guides/realtime-mcp):** Give realtime models access to new capabilities via Model Context Protocol (MCP) servers.\n* **[Realtime audio transcription](/docs/guides/realtime-transcription):** Transcribe audio streams in real time over a WebSocket connection.\n\nWas this page useful?",[],[202,294,296],"ab37791e-895f-11f0-a0eb-0224a6c84d84","realtime-websocket.md","01991399-632f-7218-92fd-d9a1c6df3c46",["D",1756970443473],"Realtime API with WebSocket\n===========================\n\nConnect to the Realtime API using WebSockets on a server.\n\n[WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) are a broadly supported API for realtime data transfer, and a great choice for connecting to the OpenAI Realtime API in server-to-server applications. For browser and mobile clients, we recommend connecting via [WebRTC](/docs/guides/realtime-webrtc).\n\nIn a server-to-server integration with Realtime, your backend system will connect via WebSocket directly to the Realtime API. You can use a [standard API key](/settings/organization/api-keys) to authenticate this connection, since the token will only be available on your secure backend server.\n\n![connect directly to realtime API](https://openaidevs.retool.com/api/file/464d4334-c467-4862-901b-d0c6847f003a)\n\nConnect via WebSocket\n---------------------\n\nBelow are several examples of connecting via WebSocket to the Realtime API. In addition to using the WebSocket URL below, you will also need to pass an authentication header using your OpenAI API key.\n\nIt is possible to use WebSocket in browsers with an ephemeral API token as shown in the [WebRTC connection guide](/docs/guides/realtime-webrtc), but if you are connecting from a client like a browser or mobile app, WebRTC will be a more robust solution in most cases.\n\nws module (Node.js)\n\nConnect using the ws module (Node.js)\n\n```javascript\nimport WebSocket from \"ws\";\n\nconst url = \"wss://api.openai.com/v1/realtime?model=gpt-realtime\";\nconst ws = new WebSocket(url, {\n headers: {\n Authorization: \"Bearer \" + process.env.OPENAI_API_KEY,\n },\n});\n\nws.on(\"open\", function open() {\n console.log(\"Connected to server.\");\n});\n\nws.on(\"message\", function incoming(message) {\n console.log(JSON.parse(message.toString()));\n});\n```\n\nwebsocket-client (Python)\n\nConnect with websocket-client (Python)\n\n```python\n# example requires websocket-client library:\n# pip install websocket-client\n\nimport os\nimport json\nimport websocket\n\nOPENAI_API_KEY = os.environ.get(\"OPENAI_API_KEY\")\n\nurl = \"wss://api.openai.com/v1/realtime?model=gpt-realtime\"\nheaders = [\"Authorization: Bearer \" + OPENAI_API_KEY]\n\ndef on_open(ws):\n print(\"Connected to server.\")\n\ndef on_message(ws, message):\n data = json.loads(message)\n print(\"Received event:\", json.dumps(data, indent=2))\n\nws = websocket.WebSocketApp(\n url,\n header=headers,\n on_open=on_open,\n on_message=on_message,\n)\n\nws.run_forever()\n```\n\nWebSocket (browsers)\n\nConnect with standard WebSocket (browsers)\n\n```javascript\n/*\nNote that in client-side environments like web browsers, we recommend\nusing WebRTC instead. It is possible, however, to use the standard \nWebSocket interface in browser-like environments like Deno and \nCloudflare Workers.\n*/\n\nconst ws = new WebSocket(\n \"wss://api.openai.com/v1/realtime?model=gpt-realtime\",\n [\n \"realtime\",\n // Auth\n \"openai-insecure-api-key.\" + OPENAI_API_KEY, \n // Optional\n \"openai-organization.\" + OPENAI_ORG_ID,\n \"openai-project.\" + OPENAI_PROJECT_ID,\n ]\n);\n\nws.on(\"open\", function open() {\n console.log(\"Connected to server.\");\n});\n\nws.on(\"message\", function incoming(message) {\n console.log(message.data);\n});\n```\n\nSending and receiving events\n----------------------------\n\nRealtime API sessions are managed using a combination of [client-sent events](/docs/api-reference/realtime_client_events/session) emitted by you as the developer, and [server-sent events](/docs/api-reference/realtime_server_events/error) created by the Realtime API to indicate session lifecycle events.\n\nOver a WebSocket, you will both send and receive JSON-serialized events as strings of text, as in this Node.js example below (the same principles apply for other WebSocket libraries):\n\n```javascript\nimport WebSocket from \"ws\";\n\nconst url = \"wss://api.openai.com/v1/realtime?model=gpt-realtime\";\nconst ws = new WebSocket(url, {\n headers: {\n Authorization: \"Bearer \" + process.env.OPENAI_API_KEY,\n },\n});\n\nws.on(\"open\", function open() {\n console.log(\"Connected to server.\");\n\n // Send client events over the WebSocket once connected\n ws.send(\n JSON.stringify({\n type: \"session.update\",\n session: {\n type: \"realtime\",\n instructions: \"Be extra nice today!\",\n },\n })\n );\n});\n\n// Listen for and parse server events\nws.on(\"message\", function incoming(message) {\n console.log(JSON.parse(message.toString()));\n});\n```\n\nThe WebSocket interface is perhaps the lowest-level interface available to interact with a Realtime model, where you will be responsible for both sending and processing Base64-encoded audio chunks over the socket connection.\n\nTo learn how to send and receive audio over Websockets, refer to the [Realtime conversations guide](/docs/guides/realtime-conversations#handling-audio-with-websockets).\n\nWas this page useful?",[],[202,294,303],"ab37720c-895f-11f0-a0eb-0224a6c84d84","realtime-webrtc.md","01991399-632f-7218-92fd-d55e129f6e36",["D",1756970443473],"Realtime API with WebRTC\n========================\n\nConnect to the Realtime API using WebRTC.\n\n[WebRTC](https://webrtc.org/) is a powerful set of standard interfaces for building real-time applications. The OpenAI Realtime API supports connecting to realtime models through a WebRTC peer connection.\n\nFor browser-based speech-to-speech voice applications, we recommend starting with the [Agents SDK for TypeScript](https://openai.github.io/openai-agents-js/guides/voice-agents/quickstart/), which provides higher-level helpers and APIs for managing Realtime sessions. The WebRTC interface is powerful and flexible, but lower level than the Agents SDK.\n\nWhen connecting to a Realtime model from the client (like a web browser or mobile device), we recommend using WebRTC rather than WebSocket for more consistent performance.\n\nOverview\n--------\n\nConnecting to the Realtime API via WebRTC requires a backend server that can generate an ephemeral API key that can be safely used in a client-side environment (like a browser).\n\nThe process for initializing a WebRTC connection using an ephemeral API key is as follows:\n\n1. A browser makes a request to a developer-controlled server to mint an ephemeral API key.\n2. The developer's server uses a [standard API key](/settings/organization/api-keys) to request an ephemeral key from the [OpenAI REST API](/docs/api-reference/realtime-sessions), and returns that new key to the browser.\n3. The browser uses the ephemeral key to authenticate a session directly with the OpenAI Realtime API as a [WebRTC peer connection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection).\n\n![connect to realtime via WebRTC](https://openaidevs.retool.com/api/file/55b47800-9aaf-48b9-90d5-793ab227ddd3)\n\nInitializing a peer connection\n------------------------------\n\nIn the browser, you can use standard WebRTC APIs to initialize a peer connection object. The code below requires a server-side endpoint that generates an ephemeral API token (which we'll see code for in a moment).\n\n```javascript\n// Get a session token for OpenAI Realtime API\nconst tokenResponse = await fetch(\"/token\");\nconst data = await tokenResponse.json();\nconst EPHEMERAL_KEY = data.value;\n\n// Create a peer connection\nconst pc = new RTCPeerConnection();\n\n// Set up to play remote audio from the model\naudioElement.current = document.createElement(\"audio\");\naudioElement.current.autoplay = true;\npc.ontrack = (e) => (audioElement.current.srcObject = e.streams[0]);\n\n// Add local audio track for microphone input in the browser\nconst ms = await navigator.mediaDevices.getUserMedia({\n audio: true,\n});\npc.addTrack(ms.getTracks()[0]);\n\n// Set up data channel for sending and receiving events\nconst dc = pc.createDataChannel(\"oai-events\");\n\n// Start the session using the Session Description Protocol (SDP)\nconst offer = await pc.createOffer();\nawait pc.setLocalDescription(offer);\n\nconst baseUrl = \"https://api.openai.com/v1/realtime/calls\";\nconst model = \"gpt-realtime\";\nconst sdpResponse = await fetch(`${baseUrl}?model=${model}`, {\n method: \"POST\",\n body: offer.sdp,\n headers: {\n Authorization: `Bearer ${EPHEMERAL_KEY}`,\n \"Content-Type\": \"application/sdp\",\n },\n});\n\nconst answer = {\n type: \"answer\",\n sdp: await sdpResponse.text(),\n};\nawait pc.setRemoteDescription(answer);\n```\n\nThe WebRTC APIs provide rich controls for handling media streams and input devices. For more guidance on building user interfaces on top of WebRTC, [refer to the docs on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API).\n\nSee the next section for details on implementing the server-side component that powers the `/token` endpoint used in the code above.\n\nCreating an ephemeral token\n---------------------------\n\nTo create an ephemeral token to use on the client-side, you will need to build a small server-side application (or integrate with an existing one) to make an [OpenAI REST API](/docs/api-reference/realtime-sessions) request for an ephemeral key. You will use a [standard API key](/settings/organization/api-keys) to authenticate this request on your backend server.\n\nBelow is an example of a simple Node.js [express](https://expressjs.com/) server which mints an ephemeral API key using the REST API:\n\n```javascript\nimport express from \"express\";\n\nconst app = express();\n\nconst sessionConfig = JSON.stringify({\n session: {\n type: \"realtime\",\n model: \"gpt-realtime\",\n audio: {\n output: {\n voice: \"marin\",\n },\n },\n },\n});\n\n// An endpoint which would work with the client code above - it returns\n// the contents of a REST API request to this protected endpoint\napp.get(\"/token\", async (req, res) => {\n try {\n const response = await fetch(\n \"https://api.openai.com/v1/realtime/client_secrets\",\n {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${apiKey}`,\n \"Content-Type\": \"application/json\",\n },\n body: sessionConfig,\n }\n );\n\n const data = await response.json();\n res.json(data);\n } catch (error) {\n console.error(\"Token generation error:\", error);\n res.status(500).json({ error: \"Failed to generate token\" });\n }\n});\n\napp.listen(3000);\n```\n\nYou can create a server endpoint like this one on any platform that can send and receive HTTP requests. Just ensure that **you only use standard OpenAI API keys on the server, not in the browser.**\n\nSending and receiving events\n----------------------------\n\nRealtime API sessions are managed using a combination of [client-sent events](/docs/api-reference/realtime_client_events/session) emitted by you as the developer, and [server-sent events](/docs/api-reference/realtime_server_events/error) created by the Realtime API to indicate session lifecycle events.\n\nWhen connecting to a Realtime model via WebRTC, you will not have to handle audio events to hear model responses in the same granular way you must with [WebSockets](/docs/guides/realtime-websocket). The WebRTC peer connection object, if configured as above, will do much of that work for you.\n\nTo send and receive other client and server events, you will use the WebRTC peer connection's [data channel](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Using_data_channels).\n\n```javascript\n// This is the data channel set up in the browser code above...\nconst dc = pc.createDataChannel(\"oai-events\");\n\n// Listen for server events\ndc.addEventListener(\"message\", (e) => {\n const event = JSON.parse(e.data);\n console.log(event);\n});\n\n// Send client events\nconst event = {\n type: \"conversation.item.create\",\n item: {\n type: \"message\",\n role: \"user\",\n content: [\n {\n type: \"input_text\",\n text: \"hello there!\",\n },\n ],\n },\n};\ndc.send(JSON.stringify(event));\n```\n\nTo learn more about managing Realtime conversations, refer to the [Realtime conversations guide](/docs/guides/realtime-conversations).\n\n[\n\nRealtime Console\n\nCheck out the WebRTC Realtime API in this light weight example app.\n\n/Users/emcho/devel/openai-realtime-console\n\nWas this page useful?",[],[202,294,310],"ab376bb8-895f-11f0-a0eb-0224a6c84d84","realtime-transcription.md","01991399-632f-7218-92fd-d36670a8a20e",["D",1756970443473],"Realtime transcription\n======================\n\nLearn how to transcribe audio in real-time with the Realtime API.\n\nYou can use the Realtime API for transcription-only use cases, either with input from a microphone or from a file. For example, you can use it to generate subtitles or transcripts in real-time. With the transcription-only mode, the model will not generate responses.\n\nIf you want the model to produce responses, you can use the Realtime API in [speech-to-speech conversation mode](/docs/guides/realtime-conversations).\n\nRealtime transcription sessions\n-------------------------------\n\nTo use the Realtime API for transcription, you need to create a transcription session, connecting via [WebSockets](/docs/guides/realtime?use-case=transcription#connect-with-websockets) or [WebRTC](/docs/guides/realtime?use-case=transcription#connect-with-webrtc).\n\nUnlike the regular Realtime API sessions for conversations, the transcription sessions typically don't contain responses from the model.\n\nThe transcription session object is also different from regular Realtime API sessions:\n\n```json\n{\n object: \"realtime.transcription_session\",\n id: string,\n input_audio_format: string,\n input_audio_transcription: [{\n model: string,\n prompt: string,\n language: string\n }],\n turn_detection: {\n type: \"server_vad\",\n threshold: float,\n prefix_padding_ms: integer,\n silence_duration_ms: integer,\n } | null,\n input_audio_noise_reduction: {\n type: \"near_field\" | \"far_field\"\n },\n include: list[string] | null\n}\n```\n\nSome of the additional properties transcription sessions support are:\n\n* `input_audio_transcription.model`: The transcription model to use, currently `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `whisper-1` are supported\n* `input_audio_transcription.prompt`: The prompt to use for the transcription, to guide the model (e.g. \"Expect words related to technology\")\n* `input_audio_transcription.language`: The language to use for the transcription, ideally in ISO-639-1 format (e.g. \"en\", \"fr\"...) to improve accuracy and latency\n* `input_audio_noise_reduction`: The noise reduction configuration to use for the transcription\n* `include`: The list of properties to include in the transcription events\n\nPossible values for the input audio format are: `pcm16` (default), `g711_ulaw` and `g711_alaw`.\n\nYou can find more information about the transcription session object in the [API reference](/docs/api-reference/realtime-sessions/transcription_session_object).\n\nHandling transcriptions\n-----------------------\n\nWhen using the Realtime API for transcription, you can listen for the `conversation.item.input_audio_transcription.delta` and `conversation.item.input_audio_transcription.completed` events.\n\nFor `whisper-1` the `delta` event will contain full turn transcript, same as `completed` event. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` the `delta` event will contain incremental transcripts as they are streamed out from the model.\n\nHere is an example transcription delta event:\n\n```json\n{\n \"event_id\": \"event_2122\",\n \"type\": \"conversation.item.input_audio_transcription.delta\",\n \"item_id\": \"item_003\",\n \"content_index\": 0,\n \"delta\": \"Hello,\"\n}\n```\n\nHere is an example transcription completion event:\n\n```json\n{\n \"event_id\": \"event_2122\",\n \"type\": \"conversation.item.input_audio_transcription.completed\",\n \"item_id\": \"item_003\",\n \"content_index\": 0,\n \"transcript\": \"Hello, how are you?\"\n}\n```\n\nNote that ordering between completion events from different speech turns is not guaranteed. You should use `item_id` to match these events to the `input_audio_buffer.committed` events and use `input_audio_buffer.committed.previous_item_id` to handle the ordering.\n\nTo send audio data to the transcription session, you can use the `input_audio_buffer.append` event.\n\nYou have 2 options:\n\n* Use a streaming microphone input\n* Stream data from a wav file\n\nVoice activity detection\n------------------------\n\nThe Realtime API supports automatic voice activity detection (VAD). Enabled by default, VAD will control when the input audio buffer is committed, therefore when transcription begins.\n\nRead more about configuring VAD in our [Voice Activity Detection](/docs/guides/realtime-vad) guide.\n\nYou can also disable VAD by setting the `turn_detection` property to `null`, and control when to commit the input audio on your end.\n\nAdditional configurations\n-------------------------\n\n### Noise reduction\n\nYou can use the `input_audio_noise_reduction` property to configure how to handle noise reduction in the audio stream.\n\nThe possible values are:\n\n* `near_field`: Use near-field noise reduction.\n* `far_field`: Use far-field noise reduction.\n* `null`: Disable noise reduction.\n\nThe default value is `near_field`, and you can disable noise reduction by setting the property to `null`.\n\n### Using logprobs\n\nYou can use the `include` property to include logprobs in the transcription events, using `item.input_audio_transcription.logprobs`.\n\nThose logprobs can be used to calculate the confidence score of the transcription.\n\n```json\n{\n \"type\": \"transcription_session.update\",\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500,\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": [ \n \"item.input_audio_transcription.logprobs\",\n ],\n}\n```\n\nWas this page useful?",[],[202,294,317],"ab3766ae-895f-11f0-a0eb-0224a6c84d84","realtime-sip.md","01991399-632f-7218-92fd-cf19f79bc9c1",["D",1756970443473],"Realtime API with SIP\n=====================\n\nConnect to the Realtime API using SIP.\n\n[SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) is a protocol used to make phone calls over the internet. With SIP and the Realtime API you can direct incoming phone calls to the API.\n\nOverview\n--------\n\nIf you want to connect a phone number to the Realtime API, use a SIP trunking provider (e.g., Twilio). This is a service that converts your phone call to IP traffic. After you purchase a phone number from your SIP trunking provider, follow the instructions below.\n\nStart by creating a [webhook](/docs/guides/webhooks) for incoming calls, at platform.openai.com. Then, point your SIP trunk at the OpenAI SIP endpoint, using the project ID for which you configured the webhook, e.g., `sip:$PROJECT_ID@sip.api.openai.com;transport=tls`. To find your `$PROJECT_ID`, go to your \\[settings\\] > **General**. The page displays the project ID. It should have a `proj_` prefix.\n\nWhen OpenAI receives SIP traffic associated with your project, the webhook that you configured will be fired. The event fired will be a [`realtime.call.incoming`](/docs/api-reference/webhook_events/realtime/call/incoming) event.\n\nThis webhook lets you accept or reject the call. When accepting the call, you'll provide the configuration (instructions, voice, etc) for the Realtime API session. Once established, you can set up a web socket and monitor the session as usual. The APIs to accept, reject, and monitor the call are documented below.\n\nConnection details\n------------------\n\nURIs used for interacting with Realtime API and SIP:\n\n|SIP URI|sip:$PROJECT_ID@sip.api.openai.com;transport=tls|\n|Accept URI|https://api.openai.com/v1/realtime/calls/$CALL_ID/accept|\n|Reject URI|https://api.openai.com/v1/realtime/calls/$CALL_ID/reject|\n|Refer URI|https://api.openai.com/v1/realtime/calls/$CALL_ID/refer|\n|Events URI|wss://api.openai.com/v1/realtime?call_id=$CALL_ID|\n\nFind your `$CALL_ID` in the `call_id` field in data object present in the webhook. See an example in the next section.\n\nHandle the webhook\n------------------\n\nThe following is an example of a `realtime.call.incoming` handler. It accepts the call and then logs all the events from the Realtime API.\n\nPython\n\nPython\n\n```python\nfrom flask import Flask, request, Response, jsonify, make_response\nfrom openai import OpenAI, InvalidWebhookSignatureError\nimport asyncio\nimport json\nimport os\nimport requests\nimport time\nimport threading\nimport websockets\n\napp = Flask(__name__)\nclient = OpenAI(\n webhook_secret=os.environ[\"OPENAI_WEBHOOK_SECRET\"]\n)\n\nAUTH_HEADER = {\n \"Authorization\": \"Bearer \" + os.getenv(\"OPENAI_API_KEY\")\n}\n\ncall_accept = {\n \"type\": \"realtime\",\n \"instructions\": \"You are a support agent.\",\n \"model\": \"gpt-4o-realtime-preview-2024-12-17\",\n}\n\nresponse_create = {\n \"type\": \"response.create\",\n \"response\": {\n \"instructions\": (\n \"Say to the user 'Thank you for calling, how can I help you'\"\n )\n },\n}\n\nasync def websocket_task(call_id):\n try:\n async with websockets.connect(\n \"wss://api.openai.com/v1/realtime?call_id=\" + call_id,\n additional_headers=AUTH_HEADER,\n ) as websocket:\n await websocket.send(json.dumps(response_create))\n\n while True:\n response = await websocket.recv()\n print(f\"Received from WebSocket: {response}\")\n except Exception as e:\n print(f\"WebSocket error: {e}\")\n\n@app.route(\"/\", methods=[\"POST\"])\ndef webhook():\n try:\n event = client.webhooks.unwrap(request.data, request.headers)\n\n if event.type == \"realtime.call.incoming\":\n requests.post(\n \"https://api.openai.com/v1/realtime/calls/\"\n + event.data.call_id\n + \"/accept\",\n headers={**AUTH_HEADER, \"Content-Type\": \"application/json\"},\n json=call_accept,\n )\n threading.Thread(\n target=lambda: asyncio.run(\n websocket_task(event.data.call_id)\n ),\n daemon=True,\n ).start()\n return Response(status=200)\n except InvalidWebhookSignatureError as e:\n print(\"Invalid signature\", e)\n return Response(\"Invalid signature\", status=400)\n\nif __name__ == \"__main__\":\n app.run(port=8000)\n```\n\nRedirect the call\n-----------------\n\nIt's also possible to redirect the call to another number. During the call, make a POST to the `refer` endpoint:\n\n|URL|https://api.openai.com/v1/realtime/calls/$CALL_ID/refer|\n|Payload|JSON with one key target_uriThis is the value used in the Refer-To. You can use Tel-URI for example tel:+14152909007|\n|Headers|Authorization: Bearer YOUR_API_KEYSubstitute YOUR_API_KEY with a standard API key|\n\nNext steps\n----------\n\nNow that you've connected over SIP, use the left navigation or click into these pages to start building your realtime application.\n\n* [Using realtime models](/docs/guides/realtime-models-prompting)\n* [Managing conversations](/docs/guides/realtime-conversations)\n* [Webhooks and server-side controls](/docs/guides/realtime-server-controls)\n* [Realtime transcription](/docs/guides/realtime-transcription)\n\nWas this page useful?",[],[202,294,324],"ab3761a4-895f-11f0-a0eb-0224a6c84d84","realtime-server-controls.md","01991399-632f-7218-92fd-c88571639480",["D",1756970443473],"Webhooks and server-side controls\n=================================\n\nUse webhooks and server-side controls with the Realtime API.\n\nThe Realtime API allows clients to connect directly to the API server via WebRTC or SIP. However, you'll most likely want tool use and other business logic to reside on your application server to keep this logic private and client-agnostic.\n\nKeep tool use, business logic, and other details secure on the server side by connecting over a “sideband” control channel. We now have sideband options for both SIP and WebRTC connections.\n\nWith WebRTC\n-----------\n\nWhen [establishing a peer connection](/docs/guides/realtime-webrtc), you receive an SDP response from the Realtime API to configure the connection. If you used the sample code from the WebRTC guide, that looks something like this:\n\n```javascript\nconst baseUrl = \"https://api.openai.com/v1/realtime/calls\";\nconst model = \"gpt-realtime\";\nconst sdpResponse = await fetch(`${baseUrl}?model=${model}`, {\n method: \"POST\",\n body: offer.sdp,\n headers: {\n Authorization: `Bearer ${EPHEMERAL_KEY}`,\n \"Content-Type\": \"application/sdp\",\n },\n});\n```\n\nThe SDP response will contain a `Location` header that has a unique call ID that can be used on the server to establish a WebSocket connection to that same Realtime session.\n\n```javascript\nconst location = sdpResponse.headers.get(\"Location\");\nconst callId = location?.split(\"/\").pop();\nconsole.log(callId);\n// rtc_u1_9c6574da8b8a41a18da9308f4ad974ce\n```\n\nOn a server, you can then [listen for events and configure the session](/docs/guides/realtime-conversations) just as you would from the client, using the ID from this URL:\n\n```javascript\nimport WebSocket from \"ws\";\n\n// You'll need to get the call ID from the browser to your\n// server somehow:\nconst callId = \"rtc_u1_9c6574da8b8a41a18da9308f4ad974ce\";\n\n// Connect to a WebSocket for the in-progress call\nconst url = \"wss://api.openai.com/v1/realtime?call_id=\" + callId;\nconst ws = new WebSocket(url, {\n headers: {\n Authorization: \"Bearer \" + process.env.OPENAI_API_KEY,\n },\n});\n\nws.on(\"open\", function open() {\n console.log(\"Connected to server.\");\n\n // Send client events over the WebSocket once connected\n ws.send(\n JSON.stringify({\n type: \"session.update\",\n session: {\n type: \"realtime\",\n instructions: \"Be extra nice today!\",\n },\n })\n );\n});\n\n// Listen for and parse server events\nws.on(\"message\", function incoming(message) {\n console.log(JSON.parse(message.toString()));\n});\n```\n\nIn this way, you are able to add tools, monitor sessions, and carry out business logic on the server instead of needing to configure those actions on the client.\n\n### With SIP\n\n1. A user connects to OpenAI via phone over SIP.\n2. OpenAI sends a webhook to your application’s backend webhook URL, notifying your app of the state of the session.\n\n```text\nPOST https://my_website.com/webhook_endpoint\nuser-agent: OpenAI/1.0 (+https://platform.openai.com/docs/webhooks)\ncontent-type: application/json\nwebhook-id: wh_685342e6c53c8190a1be43f081506c52 # unique id for idempotency\nwebhook-timestamp: 1750287078 # timestamp of delivery attempt\nwebhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=\n\n{\n\"object\": \"event\",\n\"id\": \"evt_685343a1381c819085d44c354e1b330e\",\n\"type\": \"realtime.call.incoming\",\n\"created_at\": 1750287018, // Unix timestamp\n\"data\": {\n\"call_id\": \"some_unique_id\",\n\"sip_headers\": [\n{ \"name\": \"From\", \"value\": \"sip:+142555512112@sip.example.com\" },\n{ \"name\": \"To\", \"value\": \"sip:+18005551212@sip.example.com\" },\n{ \"name\": \"Call-ID\", \"value\": \"03782086-4ce9-44bf-8b0d-4e303d2cc590\"}\n],\n}\n}\n```\n\n3. The application server opens a WebSocket connection to the Realtime API using the `call_id` value provided in the webhook. This `call_id` looks like this: `wss://api.openai.com/v1/realtime?call_id={callId}`. The WebSocket connection will live for the life of the SIP call.\n\nWas this page useful?",[],[202,294,331],"ab374fc0-895f-11f0-a0eb-0224a6c84d84","realtime-models-prompting.md","01991399-632f-7218-92fd-c58b77f2ed6d",["D",1756970443473],"Using realtime models\n=====================\n\nUse realtime models and prompting effectively.\n\nRealtime models are post-trained for specific customer use cases. In response to your feedback, the latest speech-to-speech model works differently from previous models. Use this guide to understand and get the most out of it.\n\nMeet the models\n---------------\n\nOur most advanced speech-to-speech model is [gpt-realtime](/docs/models/gpt-realtime).\n\nThis model shows improvements in following complex instructions, calling tools, and producing speech that sounds natural and expressive. For more information, see the [announcement blog post](https://openai.com/index/introducing-gpt-realtime/).\n\nUpdate your session to use a prompt\n-----------------------------------\n\nAfter you initiate a session over [WebRTC](/docs/guides/realtime-webrtc), [WebSocket](/docs/guides/realtime-websocket), or [SIP](/docs/guides/realtime-sip), the client and model are connected. The server will send a [session.created](/docs/api-reference/realtime-server-events/session/created) event to confirm. Now it's a matter of prompting.\n\n### Basic prompt update\n\n1. Create a basic audio prompt in [the dashboard](/audio/realtime).\n \n If you don't know where to start, experiment with the prompt fields until you find something interesting. You can always manage, iterate on, and version your prompts later.\n \n2. Update your realtime session to use the prompt you created. Provide its prompt ID in a `session.update` client event:\n \n\nUpdate the system instructions used by the model in this session\n\n```javascript\nconst event = {\n type: \"session.update\",\n session: {\n type: \"realtime\",\n model: \"gpt-realtime\",\n // Lock the output to audio (add \"text\" if you also want text)\n output_modalities: [\"audio\"],\n audio: {\n input: {\n format: \"pcm16\",\n turn_detection: { type: \"semantic_vad\", create_response: true }\n },\n output: {\n format: \"g711_ulaw\",\n voice: \"alloy\",\n speed: 1.0\n }\n },\n // Use a server-stored prompt by ID. Optionally pin a version and pass variables.\n prompt: {\n id: \"pmpt_123\", // your stored prompt ID\n // version: \"89\", // optional: pin a specific version\n variables: {\n city: \"Paris\" // example variable used by your prompt\n }\n },\n // You can still set direct session fields; these override prompt fields if they overlap:\n instructions: \"Speak clearly and briefly. Confirm understanding before taking actions.\"\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nevent = {\n \"type\": \"session.update\",\n session: {\n type: \"realtime\",\n model: \"gpt-realtime\",\n // Lock the output to audio (add \"text\" if you also want text)\n output_modalities: [\"audio\"],\n audio: {\n input: {\n format: \"pcm16\",\n turn_detection: { type: \"semantic_vad\", create_response: true }\n },\n output: {\n format: \"g711_ulaw\",\n voice: \"alloy\",\n speed: 1.0\n }\n },\n // Use a server-stored prompt by ID. Optionally pin a version and pass variables.\n prompt: {\n id: \"pmpt_123\", // your stored prompt ID\n // version: \"89\", // optional: pin a specific version\n variables: {\n city: \"Paris\" // example variable used by your prompt\n }\n },\n // You can still set direct session fields; these override prompt fields if they overlap:\n instructions: \"Speak clearly and briefly. Confirm understanding before taking actions.\"\n }\n}\nws.send(json.dumps(event))\n```\n\nWhen the session's updated, the server emits a [session.updated](/docs/api-reference/realtime-server-events/session/updated) event with the new state of the session. You can update the session any time.\n\n### Changing prompt mid-call\n\nTo update the session mid-call (to swap prompt version or variables, or override instructions), send the update over the same data channel you're using:\n\n```text\n// Example: switch to a specific prompt version and change a variable\ndc.send(JSON.stringify({\n type: \"session.update\",\n session: {\n prompt: {\n id: \"pmpt_123\",\n version: \"89\",\n variables: {\n city: \"Berlin\"\n }\n }\n }\n}));\n\n// Example: override instructions (note: direct session fields take precedence over Prompt fields)\ndc.send(JSON.stringify({\n type: \"session.update\",\n session: {\n instructions: \"Speak faster and keep answers under two sentences.\"\n }\n}));\n```\n\nPrompting gpt-realtime\n----------------------\n\nHere are top tips for prompting the realtime speech-to-speech model. For a more in-depth guide to prompting, see the [realtime prompting cookbook](https://cookbook.openai.com/examples/realtime_prompting_guide).\n\n### General usage tips\n\n* **Iterate relentlessly**. Small wording changes can make or break behavior.\n \n Example: Swapping “inaudible” → “unintelligible” improved noisy input handling.\n \n* **Use bullets over paragraphs**. Clear, short bullets outperform long paragraphs.\n \n* **Guide with examples**. The model strongly follows onto sample phrases.\n \n* **Be precise**. Ambiguity and conflicting instructions degrade performance, similar to GPT-5.\n \n* **Control language**. Pin output to a target language if you see drift.\n \n* **Reduce repetition**. Add a variety rule to reduce robotic phrasing.\n \n* **Use all caps for emphasis**: Capitalize key rules to makes them stand out to the model.\n \n* **Convert non-text rules to text**: The model responds better to clearly written text.\n \n Example: Instead of writing, \"IF x > 3 THEN ESCALATE\", write, \"IF MORE THAN THREE FAILURES THEN ESCALATE.\"\n \n\n### Structure your prompt\n\nOrganize your prompt to help the model understand context and stay consistent across turns.\n\nUse clear, labeled sections in your system prompt so the model can find and follow them. Keep each section focused on one thing.\n\n```text\n# Role & Objective — who you are and what “success” means\n# Personality & Tone — the voice and style to maintain\n# Context — retrieved context, relevant info\n# Reference Pronunciations — phonetic guides for tricky words\n# Tools — names, usage rules, and preambles\n# Instructions / Rules — do’s, don’ts, and approach\n# Conversation Flow — states, goals, and transitions\n# Safety & Escalation — fallback and handoff logic\n```\n\nThis format also makes it easier for you to iterate and modify problematic sections.\n\nTo make this system prompt your own, add domain-specific sections (e.g., Compliance, Brand Policy) and remove sections you don’t need. In each section, provide instructions and other information for the model to respond correctly. See specifics below.\n\nPractical tips for prompting realtime models\n--------------------------------------------\n\nHere are 10 tips for creating effective, consistently performing prompts with gpt-realtime. These are just an overview. For more details and full system prompt examples, see the [realtime prompting cookbook](https://cookbook.openai.com/examples/realtime_prompting_guide).\n\n#### 1\\. Be precise. Kill conflicts.\n\nThe new realtime model is very good at instruction following. However, that also means small wording changes or unclear instructions can shift behavior in meaningful ways. Inspect and iterate on your system prompt to try different phrasing and fix instruction contradictions.\n\nIn one experiment we ran, changing the word \"inaudible\" to \"unintelligble\" in instructions for handling noisy inputs significantly improved the model's performance.\n\nAfter your first attempt at a system prompt, have an LLM review it for ambiguity or conflicts.\n\n#### 2\\. Bullets > paragraphs.\n\nRealtime models follow short bullet points better than long paragraphs.\n\nBefore (harder to follow):\n\n```text\nWhen you can’t clearly hear the user, don’t proceed. If there’s background noise or you only caught part of the sentence, pause and ask them politely to repeat themselves in their preferred language, and make sure you keep the conversation in the same language as the user.\n```\n\nAfter (easier to follow):\n\n```text\nOnly respond to clear audio or text.\n\nIf audio is unclear/partial/noisy/silent, ask for clarification in `{preferred_language}`.\n\nContinue in the same language as the user if intelligible.\n```\n\n#### 3\\. Handle unclear audio.\n\nThe realtime model is good at following instructions on how to handle unclear audio. Spell out what to do when audio isn’t usable.\n\n```text\n## Unclear audio\n- Always respond in the same language the user is speaking in, if intelligible.\n- Only respond to clear audio or text.\n- If the user's audio is not clear (e.g., ambiguous input/background noise/silent/unintelligible) or if you did not fully hear or understand the user, ask for clarification using {preferred_language} phrases.\n\nSample clarification phrases (parameterize with {preferred_language}):\n\n- “Sorry, I didn’t catch that—could you say it again?”\n- “There’s some background noise. Please repeat the last part.”\n- “I only heard part of that. What did you say after ___?”\n```\n\n#### 4\\. Constrain the model to one language.\n\nIf you see the model switching languages in an unhelpful way, add a dedicated \"Language\" section in your prompt. Make sure it doesn’t conflict with other rules. By default, mirroring the user’s language works well.\n\nHere's a simple way to mirror the user's language:\n\n```text\n## Language\nLanguage matching: Respond in the same language as the user unless directed otherwise.\nFor non-English, start with the same standard accent/dialect the user uses.\n```\n\nHere's an example of an English-only constraint:\n\n```text\n## Language\n- The conversation will be only in English.\n- Do not respond in any other language, even if the user asks.\n- If the user speaks another language, politely explain that support is limited to English.\n```\n\nIn a language teaching application, your language and conversation sections might look like this:\n\n```text\n## Language\n### Explanations\nUse English when explaining grammar, vocabulary, or cultural context.\n\n### Conversation\nSpeak in French when conducting practice, giving examples, or engaging in dialogue.\n```\n\nYou can also control dialect for a more consistent personality:\n\n```text\n## Language\nResponse only in argentine spanish.\n```\n\n#### 5\\. Provide sample phrases and flow snippets.\n\nThe model learns style from examples. Give short, varied samples for common conversation moments.\n\nFor example, you might give this high-level shape of conversation flow to the model:\n\n```text\nGreeting → Discover → Verify → Diagnose → Resolve → Confirm/Close. Advance only when criteria in each phase are met.\n```\n\nAnd then provide prompt guidance for each section. For example, here's how you might instruct for the greeting section:\n\n```text\n## Conversation flow — Greeting\nGoal: Set tone and invite the reason for calling.\n\nHow to respond:\n- Identify as ACME Internet Support.\n- Keep it brief; invite the caller’s goal.\n\nSample phrases (vary, don’t always reuse):\n- “Thanks for calling ACME Internet—how can I help today?”\n- “You’ve reached ACME Support. What’s going on with your service?”\n- “Hi there—tell me what you’d like help with.”\n\nExit when: Caller states an initial goal or symptom.\n```\n\n#### 6\\. Avoid robotic repetition.\n\nIf responses sound repetitive or robotic, include an explicit variety instruction. This can sometimes happen when using sample phrases.\n\n```text\n## Variety\n- Do not repeat the same sentence twice. Vary your responses so it doesn't sound robotic.\n```\n\n#### 7\\. Use capitalized text to emphasize instructions.\n\nLike many LLMs, using capitalization for important rules can help the model to understand and follow those rules. It's also helpful to convert non-text rules (such as numerical conditions) into text before capitalization.\n\nInstead of:\n\n```text\n## Rules\n- If [func.return_value] > 0, respond 1 to the user.\n```\n\nUse:\n\n```text\n## Rules\n- IF [func.return_value] IS BIGGER THAN 0, RESPOND 1 TO THE USER.\n```\n\n#### 8\\. Help the model use tools.\n\nThe model's use of tools can alter the experience—how much they rely on user confirmation vs. taking action, what they say while they make the tool call, which rules they follow for each specific tool, etc.\n\nOne way to prompt for tool usage is to use preambles. Good preambles instruct the model to give the user some feedback about what it's doing before it makes the tool call, so the user always knows what's going on.\n\nHere's an example:\n\n```text\n# Tools\n- Before any tool call, say one short line like “I’m checking that now.” Then call the tool immediately.\n```\n\nYou can include sample phrases for preambles to add variety and better tailor to your use case.\n\nThere are several other ways to improve the model's behavior when performing tool calls and keeping the conversation going with the user. Ideally, the model is calling the right tools proactively, checking for confirmation for any important write actions, and keeping the user informed along the way. For more specifics, see the [realtime prompting cookbook](https://cookbook.openai.com/examples/realtime_prompting_guide).\n\n#### 9\\. Use LLMs to improve your prompt.\n\nLLMs are great at finding what's going wrong in your prompt. Use ChatGPT or the API to get a model's review of your current realtime prompt and get help improving it.\n\nWhether your prompt is working well or not, here's a prompt you can run to get a model's review:\n\n```text\n## Role & Objective\nYou are a **Prompt-Critique Expert**.\nExamine a user-supplied LLM prompt and surface any weaknesses following the instructions below.\n\n## Instructions\nReview the prompt that is meant for an LLM to follow and identify the following issues:\n- Ambiguity: Could any wording be interpreted in more than one way?\n- Lacking Definitions: Are there any class labels, terms, or concepts that are not defined that might be misinterpreted by an LLM?\n- Conflicting, missing, or vague instructions: Are directions incomplete or contradictory?\n- Unstated assumptions: Does the prompt assume the model has to be able to do something that is not explicitly stated?\n\n## Do **NOT** list issues of the following types:\n- Invent new instructions, tool calls, or external information. You do not know what tools need to be added that are missing.\n- Issues that you are not sure about.\n\n## Output Format\n\n# Issues\n- Numbered list; include brief quote snippets.\n\n# Improvements\n- Numbered list; provide the revised lines you would change and how you would changed them.\n\n# Revised Prompt\n- Revised prompt where you have applied all your improvements surgically with minimal edits to the original prompt\n```\n\nUse this template as a starting point for troubleshooting a recurring issue:\n\n```text\nHere's my current prompt to an LLM:\n[BEGIN OF CURRENT PROMPT]\n{CURRENT_PROMPT}\n[END OF CURRENT PROMPT]\n\nBut I see this issue happening from the LLM:\n[BEGIN OF ISSUE]\n{ISSUE}\n[END OF ISSUE]\nCan you provide some variants of the prompt so that the model can better understand the constraints to alleviate the issue?\n```\n\n#### 10\\. Help users resolve issues faster.\n\nTwo frustrating user experiences are slow, mechanical voice agents and the inability to escalate. Help users faster by providing instructions in your system prompt for speed and escalation.\n\nIn the personality and tone section of your system prompt, add pacing instructions to get the model to quicken its support:\n\n```text\n# Personality & Tone\n## Personality\nFriendly, calm and approachable expert customer service assistant.\n\n## Tone\nTone: Warm, concise, confident, never fawning.\n\n## Length\n2–3 sentences per turn.\n\n## Pacing\nDeliver your audio response fast, but do not sound rushed. Do not modify the content of your response, only increase speaking speed for the same response.\n```\n\nOften with realtime voice agents, having a reliable way to escalate to a human is important. In a safety and escalation section, modify the instructions on WHEN to escalate depending on your use case. Here's an example:\n\n```text\n# Safety & Escalation\nWhen to escalate (no extra troubleshooting):\n- Safety risk (self-harm, threats, harassment)\n- User explicitly asks for a human\n- Severe dissatisfaction (e.g., “extremely frustrated,” repeated complaints, profanity)\n- **2** failed tool attempts on the same task **or** **3** consecutive no-match/no-input events\n- Out-of-scope or restricted (e.g., real-time news, financial/legal/medical advice)\n\nWhat to say at the same time of calling the escalate_to_human tool (MANDATORY):\n- “Thanks for your patience—**I’m connecting you with a specialist now**.”\n- Then call the tool: `escalate_to_human`\n\nExamples that would require escalation:\n- “This is the third time the reset didn’t work. Just get me a person.”\n- “I am extremely frustrated!”\n```\n\nFurther reading\n---------------\n\nThis guide is long but not exhaustive! For more in a specific area, see the following resources:\n\n* [Realtime prompting cookbook](https://cookbook.openai.com/examples/realtime_prompting_guide): Full prompt examples and a deep dive into when and how to use them\n* [Inputs and outputs](/docs/guides/realtime-inputs-outputs): Text and audio input requirements and output options\n* [Managing conversations](/docs/guides/realtime-conversations): Learn to manage a conversation for the duration of a realtime session\n* [Webhooks and server-side controls](/docs/guides/realtime-server-controls): Create a sideband channel to separate sensitive server-side logic from an untrusted client\n* [Function calling](/docs/guides/realtime-function-calling): How to call functions in your realtime app\n* [MCP servers](/docs/guides/realtime-mcp): How to use MCP servers to access additional tools in realtime apps\n* [Realtime transcription](/docs/guides/realtime-transcription): How to transcribe audio with the Realtime API\n* [Voice agents](https://openai.github.io/openai-agents-js/guides/voice-agents/quickstart/): A quickstart for building a voice agent with the Agents SDK\n\nWas this page useful?",[],[202,294,338],"ab372388-895f-11f0-a0eb-0224a6c84d84","realtime-conversations.md","01991399-632f-7218-92fd-c2614ef0f022",["D",1756970443473],"Realtime conversations\n======================\n\nLearn how to manage Realtime speech-to-speech conversations.\n\nOnce you have connected to the Realtime API through either [WebRTC](/docs/guides/realtime-webrtc) or [WebSocket](/docs/guides/realtime-websocket), you can call a Realtime model (such as [gpt-4o-realtime-preview](/docs/models/gpt-4o-realtime-preview)) to have speech-to-speech conversations. Doing so will require you to **send client events** to initiate actions, and **listen for server events** to respond to actions taken by the Realtime API.\n\nThis guide will walk through the event flows required to use model capabilities like audio and text generation and function calling, and how to think about the state of a Realtime Session.\n\nIf you do not need to have a conversation with the model, meaning you don't expect any response, you can use the Realtime API in [transcription mode](/docs/guides/realtime-transcription).\n\nRealtime speech-to-speech sessions\n----------------------------------\n\nA Realtime Session is a stateful interaction between the model and a connected client. The key components of the session are:\n\n* The **Session** object, which controls the parameters of the interaction, like the model being used, the voice used to generate output, and other configuration.\n* A **Conversation**, which represents user input Items and model output Items generated during the current session.\n* **Responses**, which are model-generated audio or text Items that are added to the Conversation.\n\n**Input audio buffer and WebSockets**\n\nIf you are using WebRTC, much of the media handling required to send and receive audio from the model is assisted by WebRTC APIs.\n\n \n\nIf you are using WebSockets for audio, you will need to manually interact with the **input audio buffer** by sending audio to the server, sent with JSON events with base64-encoded audio.\n\nAll these components together make up a Realtime Session. You will use client events to update the state of the session, and listen for server events to react to state changes within the session.\n\n![diagram realtime state](https://openaidevs.retool.com/api/file/11fe71d2-611e-4a26-a587-881719a90e56)\n\nSession lifecycle events\n------------------------\n\nAfter initiating a session via either [WebRTC](/docs/guides/realtime-webrtc) or [WebSockets](/docs/guides/realtime-websockets), the server will send a [`session.created`](/docs/api-reference/realtime-server-events/session/created) event indicating the session is ready. On the client, you can update the current session configuration with the [`session.update`](/docs/api-reference/realtime-client-events/session/update) event. Most session properties can be updated at any time, except for the `voice` the model uses for audio output, after the model has responded with audio once during the session. The maximum duration of a Realtime session is **30 minutes**.\n\nThe following example shows updating the session with a `session.update` client event. See the [WebRTC](/docs/guides/realtime-webrtc#sending-and-receiving-events) or [WebSocket](/docs/guides/realtime-websocket#sending-and-receiving-events) guide for more on sending client events over these channels.\n\nUpdate the system instructions used by the model in this session\n\n```javascript\nconst event = {\n type: \"session.update\",\n session: {\n type: \"realtime\",\n model: \"gpt-realtime\",\n // Lock the output to audio (add \"text\" if you also want text)\n output_modalities: [\"audio\"],\n audio: {\n input: {\n format: \"pcm16\",\n turn_detection: { type: \"semantic_vad\", create_response: true }\n },\n output: {\n format: \"g711_ulaw\",\n voice: \"alloy\",\n speed: 1.0\n }\n },\n // Use a server-stored prompt by ID. Optionally pin a version and pass variables.\n prompt: {\n id: \"pmpt_123\", // your stored prompt ID\n // version: \"89\", // optional: pin a specific version\n variables: {\n city: \"Paris\" // example variable used by your prompt\n }\n },\n // You can still set direct session fields; these override prompt fields if they overlap:\n instructions: \"Speak clearly and briefly. Confirm understanding before taking actions.\"\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nevent = {\n \"type\": \"session.update\",\n session: {\n type: \"realtime\",\n model: \"gpt-realtime\",\n // Lock the output to audio (add \"text\" if you also want text)\n output_modalities: [\"audio\"],\n audio: {\n input: {\n format: \"pcm16\",\n turn_detection: { type: \"semantic_vad\", create_response: true }\n },\n output: {\n format: \"g711_ulaw\",\n voice: \"alloy\",\n speed: 1.0\n }\n },\n // Use a server-stored prompt by ID. Optionally pin a version and pass variables.\n prompt: {\n id: \"pmpt_123\", // your stored prompt ID\n // version: \"89\", // optional: pin a specific version\n variables: {\n city: \"Paris\" // example variable used by your prompt\n }\n },\n // You can still set direct session fields; these override prompt fields if they overlap:\n instructions: \"Speak clearly and briefly. Confirm understanding before taking actions.\"\n }\n}\nws.send(json.dumps(event))\n```\n\nWhen the session has been updated, the server will emit a [`session.updated`](/docs/api-reference/realtime-server-events/session/updated) event with the new state of the session.\n\n||\n|session.update|session.createdsession.updated|\n\nText inputs and outputs\n-----------------------\n\nTo generate text with a Realtime model, you can add text inputs to the current conversation, ask the model to generate a response, and listen for server-sent events indicating the progress of the model's response. In order to generate text, the [session must be configured](/docs/api-reference/realtime-client-events/session/update) with the `text` modality (this is true by default).\n\nCreate a new text conversation item using the [`conversation.item.create`](/docs/api-reference/realtime-client-events/conversation/item/create) client event. This is similar to sending a [user message (prompt) in Chat Completions](/docs/guides/text-generation) in the REST API.\n\nCreate a conversation item with user input\n\n```javascript\nconst event = {\n type: \"conversation.item.create\",\n item: {\n type: \"message\",\n role: \"user\",\n content: [\n {\n type: \"input_text\",\n text: \"What Prince album sold the most copies?\",\n }\n ]\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nevent = {\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"What Prince album sold the most copies?\",\n }\n ]\n }\n}\nws.send(json.dumps(event))\n```\n\nAfter adding the user message to the conversation, send the [`response.create`](/docs/api-reference/realtime-client-events/response/create) event to initiate a response from the model. If both audio and text are enabled for the current session, the model will respond with both audio and text content. If you'd like to generate text only, you can specify that when sending the `response.create` client event, as shown below.\n\nGenerate a text-only response\n\n```javascript\nconst event = {\n type: \"response.create\",\n response: {\n modalities: [ \"text\" ]\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nevent = {\n \"type\": \"response.create\",\n \"response\": {\n \"modalities\": [ \"text\" ]\n }\n}\nws.send(json.dumps(event))\n```\n\nWhen the response is completely finished, the server will emit the [`response.done`](/docs/api-reference/realtime-server-events/response/done) event. This event will contain the full text generated by the model, as shown below.\n\nListen for response.done to see the final results\n\n```javascript\nfunction handleEvent(e) {\n const serverEvent = JSON.parse(e.data);\n if (serverEvent.type === \"response.done\") {\n console.log(serverEvent.response.output[0]);\n }\n}\n\n// Listen for server messages (WebRTC)\ndataChannel.addEventListener(\"message\", handleEvent);\n\n// Listen for server messages (WebSocket)\n// ws.on(\"message\", handleEvent);\n```\n\n```python\ndef on_message(ws, message):\n server_event = json.loads(message)\n if server_event.type == \"response.done\":\n print(server_event.response.output[0])\n```\n\nWhile the model response is being generated, the server will emit a number of lifecycle events during the process. You can listen for these events, such as [`response.text.delta`](/docs/api-reference/realtime-server-events/response/text/delta), to provide realtime feedback to users as the response is generated. A full listing of the events emitted by there server are found below under **related server events**. They are provided in the rough order of when they are emitted, along with relevant client-side events for text generation.\n\n||\n|conversation.item.createresponse.create|conversation.item.createdresponse.createdresponse.output_item.addedresponse.content_part.addedresponse.text.deltaresponse.text.doneresponse.content_part.doneresponse.output_item.doneresponse.donerate_limits.updated|\n\nAudio inputs and outputs\n------------------------\n\nOne of the most powerful features of the Realtime API is voice-to-voice interaction with the model, without an intermediate text-to-speech or speech-to-text step. This enables lower latency for voice interfaces, and gives the model more data to work with around the tone and inflection of voice input.\n\n### Voice options\n\nRealtime sessions can be configured to use one of several built‑in voices when producing audio output. You can set the `voice` on session creation (or on a `response.create`) to control how the model sounds. Current voice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, and `verse`. Once the model has emitted audio in a session, the `voice` cannot be modified for that session.\n\n### Handling audio with WebRTC\n\nIf you are connecting to the Realtime API using WebRTC, the Realtime API is acting as a [peer connection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection) to your client. Audio output from the model is delivered to your client as a remote media stream. Audio input to the model is collected using audio devices ([`getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)), and media streams are added as tracks to to the peer connection.\n\nThe example code from the [WebRTC connection guide](/docs/guides/realtime-webrtc) shows a basic example of configuring both local and remote audio using browser APIs:\n\n```javascript\n// Create a peer connection\nconst pc = new RTCPeerConnection();\n\n// Set up to play remote audio from the model\nconst audioEl = document.createElement(\"audio\");\naudioEl.autoplay = true;\npc.ontrack = e => audioEl.srcObject = e.streams[0];\n\n// Add local audio track for microphone input in the browser\nconst ms = await navigator.mediaDevices.getUserMedia({\n audio: true\n});\npc.addTrack(ms.getTracks()[0]);\n```\n\nThe snippet above enables simple interaction with the Realtime API, but there's much more that can be done. For more examples of different kinds of user interfaces, check out the [WebRTC samples](https://github.com/webrtc/samples) repository. Live demos of these samples can also be [found here](https://webrtc.github.io/samples/).\n\nUsing [media captures and streams](https://developer.mozilla.org/en-US/docs/Web/API/Media_Capture_and_Streams_API) in the browser enables you to do things like mute and unmute microphones, select which device to collect input from, and more.\n\n### Client and server events for audio in WebRTC\n\nBy default, WebRTC clients don't need to send any client events to the Realtime API before sending audio inputs. Once a local audio track is added to the peer connection, your users can just start talking!\n\nHowever, WebRTC clients still receive a number of server-sent lifecycle events as audio is moving back and forth between client and server over the peer connection. Examples include:\n\n* When input is sent over the local media track, you will receive [`input_audio_buffer.speech_started`](/docs/api-reference/realtime-server-events/input_audio_buffer/speech_started) events from the server.\n* When local audio input stops, you'll receive the [`input_audio_buffer.speech_stopped`](/docs/api-reference/realtime-server-events/input_audio_buffer/speech_started) event.\n* You'll receive [delta events for the in-progress audio transcript](/docs/api-reference/realtime-server-events/response/audio_transcript/delta).\n* You'll receive a [`response.done`](/docs/api-reference/realtime-server-events/response/done) event when the model has transcribed and completed sending a response.\n\nManipulating WebRTC APIs for media streams may give you all the control you need. However, it may occasionally be necessary to use lower-level interfaces for audio input and output. Refer to the WebSockets section below for more information and a listing of events required for granular audio input handling.\n\n### Handling audio with WebSockets\n\nWhen sending and receiving audio over a WebSocket, you will have a bit more work to do in order to send media from the client, and receive media from the server. Below, you'll find a table describing the flow of events during a WebSocket session that are necessary to send and receive audio over the WebSocket.\n\nThe events below are given in lifecycle order, though some events (like the `delta` events) may happen concurrently.\n\n||\n|Session initialization|session.update|session.createdsession.updated|\n|User audio input|conversation.item.create (send whole audio message)input_audio_buffer.append (stream audio in chunks)input_audio_buffer.commit (used when VAD is disabled)response.create (used when VAD is disabled)|input_audio_buffer.speech_startedinput_audio_buffer.speech_stoppedinput_audio_buffer.committed|\n|Server audio output|input_audio_buffer.clear (used when VAD is disabled)|conversation.item.createdresponse.createdresponse.output_item.createdresponse.content_part.addedresponse.audio.deltaresponse.audio_transcript.deltaresponse.text.deltaresponse.audio.doneresponse.audio_transcript.doneresponse.text.doneresponse.content_part.doneresponse.output_item.doneresponse.donerate_limits.updated|\n\n### Streaming audio input to the server\n\nTo stream audio input to the server, you can use the [`input_audio_buffer.append`](/docs/api-reference/realtime-client-events/input_audio_buffer/append) client event. This event requires you to send chunks of **Base64-encoded audio bytes** to the Realtime API over the socket. Each chunk cannot exceed 15 MB in size.\n\nThe format of the input chunks can be configured either for the entire session, or per response.\n\n* Session: `session.input_audio_format` in [`session.update`](/docs/api-reference/realtime-client-events/session/update)\n* Response: `response.input_audio_format` in [`response.create`](/docs/api-reference/realtime-client-events/response/create)\n\nAppend audio input bytes to the conversation\n\n```javascript\nimport fs from 'fs';\nimport decodeAudio from 'audio-decode';\n\n// Converts Float32Array of audio data to PCM16 ArrayBuffer\nfunction floatTo16BitPCM(float32Array) {\n const buffer = new ArrayBuffer(float32Array.length * 2);\n const view = new DataView(buffer);\n let offset = 0;\n for (let i = 0; i < float32Array.length; i++, offset += 2) {\n let s = Math.max(-1, Math.min(1, float32Array[i]));\n view.setInt16(offset, s < 0 ? s * 0x8000 : s * 0x7fff, true);\n }\n return buffer;\n}\n\n// Converts a Float32Array to base64-encoded PCM16 data\nbase64EncodeAudio(float32Array) {\n const arrayBuffer = floatTo16BitPCM(float32Array);\n let binary = '';\n let bytes = new Uint8Array(arrayBuffer);\n const chunkSize = 0x8000; // 32KB chunk size\n for (let i = 0; i < bytes.length; i += chunkSize) {\n let chunk = bytes.subarray(i, i + chunkSize);\n binary += String.fromCharCode.apply(null, chunk);\n }\n return btoa(binary);\n}\n\n// Fills the audio buffer with the contents of three files,\n// then asks the model to generate a response.\nconst files = [\n './path/to/sample1.wav',\n './path/to/sample2.wav',\n './path/to/sample3.wav'\n];\n\nfor (const filename of files) {\n const audioFile = fs.readFileSync(filename);\n const audioBuffer = await decodeAudio(audioFile);\n const channelData = audioBuffer.getChannelData(0);\n const base64Chunk = base64EncodeAudio(channelData);\n ws.send(JSON.stringify({\n type: 'input_audio_buffer.append',\n audio: base64Chunk\n }));\n});\n\nws.send(JSON.stringify({type: 'input_audio_buffer.commit'}));\nws.send(JSON.stringify({type: 'response.create'}));\n```\n\n```python\nimport base64\nimport json\nimport struct\nimport soundfile as sf\nfrom websocket import create_connection\n\n# ... create websocket-client named ws ...\n\ndef float_to_16bit_pcm(float32_array):\n clipped = [max(-1.0, min(1.0, x)) for x in float32_array]\n pcm16 = b''.join(struct.pack(' 1 else data\n base64_chunk = base64_encode_audio(channel_data)\n \n # Send the client event\n event = {\n \"type\": \"input_audio_buffer.append\",\n \"audio\": base64_chunk\n }\n ws.send(json.dumps(event))\n```\n\n### Send full audio messages\n\nIt is also possible to create conversation messages that are full audio recordings. Use the [`conversation.item.create`](/docs/api-reference/realtime-client-events/conversation/item/create) client event to create messages with `input_audio` content.\n\nCreate full audio input conversation items\n\n```javascript\nconst fullAudio = \"\";\n\nconst event = {\n type: \"conversation.item.create\",\n item: {\n type: \"message\",\n role: \"user\",\n content: [\n {\n type: \"input_audio\",\n audio: fullAudio,\n },\n ],\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nfullAudio = \"\"\n\nevent = {\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_audio\",\n \"audio\": fullAudio,\n }\n ],\n },\n}\n\nws.send(json.dumps(event))\n```\n\n### Working with audio output from a WebSocket\n\n**To play output audio back on a client device like a web browser, we recommend using WebRTC rather than WebSockets**. WebRTC will be more robust sending media to client devices over uncertain network conditions.\n\nBut to work with audio output in server-to-server applications using a WebSocket, you will need to listen for [`response.audio.delta`](/docs/api-reference/realtime-server-events/response/audio/delta) events containing the Base64-encoded chunks of audio data from the model. You will either need to buffer these chunks and write them out to a file, or maybe immediately stream them to another source like [a phone call with Twilio](https://www.twilio.com/en-us/blog/twilio-openai-realtime-api-launch-integration).\n\nNote that the [`response.audio.done`](/docs/api-reference/realtime-server-events/response/audio/done) and [`response.done`](/docs/api-reference/realtime-server-events/response/done) events won't actually contain audio data in them - just audio content transcriptions. To get the actual bytes, you'll need to listen for the [`response.audio.delta`](/docs/api-reference/realtime-server-events/response/audio/delta) events.\n\nThe format of the output chunks can be configured either for the entire session, or per response.\n\n* Session: `session.output_audio_format` in [`session.update`](/docs/api-reference/realtime-client-events/session/update)\n* Response: `response.output_audio_format` in [`response.create`](/docs/api-reference/realtime-client-events/response/create)\n\nListen for response.audio.delta events\n\n```javascript\nfunction handleEvent(e) {\n const serverEvent = JSON.parse(e.data);\n if (serverEvent.type === \"response.audio.delta\") {\n // Access Base64-encoded audio chunks\n // console.log(serverEvent.delta);\n }\n}\n\n// Listen for server messages (WebSocket)\nws.on(\"message\", handleEvent);\n```\n\n```python\ndef on_message(ws, message):\n server_event = json.loads(message)\n if server_event.type == \"response.audio.delta\":\n # Access Base64-encoded audio chunks:\n # print(server_event.delta)\n```\n\nVoice activity detection\n------------------------\n\nBy default, Realtime sessions have **voice activity detection (VAD)** enabled, which means the API will determine when the user has started or stopped speaking and respond automatically.\n\nRead more about how to configure VAD in our [voice activity detection](/docs/guides/realtime-vad) guide.\n\n### Disable VAD\n\nVAD can be disabled by setting `turn_detection` to `null` with the [`session.update`](/docs/api-reference/realtime-client-events/session/update) client event. This can be useful for interfaces where you would like to take granular control over audio input, like [push to talk](https://en.wikipedia.org/wiki/Push-to-talk) interfaces.\n\nWhen VAD is disabled, the client will have to manually emit some additional client events to trigger audio responses:\n\n* Manually send [`input_audio_buffer.commit`](/docs/api-reference/realtime-client-events/input_audio_buffer/commit), which will create a new user input item for the conversation.\n* Manually send [`response.create`](/docs/api-reference/realtime-client-events/response/create) to trigger an audio response from the model.\n* Send [`input_audio_buffer.clear`](/docs/api-reference/realtime-client-events/input_audio_buffer/clear) before beginning a new user input.\n\n### Keep VAD, but disable automatic responses\n\nIf you would like to keep VAD mode enabled, but would just like to retain the ability to manually decide when a response is generated, you can set `turn_detection.interrupt_response` and `turn_detection.create_response` to `false` with the [`session.update`](/docs/api-reference/realtime-client-events/session/update) client event. This will retain all the behavior of VAD but not automatically create new Responses. Clients can trigger these manually with a [`response.create`](/docs/api-reference/realtime-client-events/response/create) event.\n\nThis can be useful for moderation or input validation or RAG patterns, where you're comfortable trading a bit more latency in the interaction for control over inputs.\n\nCreate responses outside the default conversation\n-------------------------------------------------\n\nBy default, all responses generated during a session are added to the session's conversation state (the \"default conversation\"). However, you may want to generate model responses outside the context of the session's default conversation, or have multiple responses generated concurrently. You might also want to have more granular control over which conversation items are considered while the model generates a response (e.g. only the last N number of turns).\n\nGenerating \"out-of-band\" responses which are not added to the default conversation state is possible by setting the `response.conversation` field to the string `none` when creating a response with the [`response.create`](/docs/api-reference/realtime-client-events/response/create) client event.\n\nWhen creating an out-of-band response, you will probably also want some way to identify which server-sent events pertain to this response. You can provide `metadata` for your model response that will help you identify which response is being generated for this client-sent event.\n\nCreate an out-of-band model response\n\n```javascript\nconst prompt = `\nAnalyze the conversation so far. If it is related to support, output\n\"support\". If it is related to sales, output \"sales\".\n`;\n\nconst event = {\n type: \"response.create\",\n response: {\n // Setting to \"none\" indicates the response is out of band\n // and will not be added to the default conversation\n conversation: \"none\",\n\n // Set metadata to help identify responses sent back from the model\n metadata: { topic: \"classification\" },\n \n // Set any other available response fields\n modalities: [ \"text\" ],\n instructions: prompt,\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nprompt = \"\"\"\nAnalyze the conversation so far. If it is related to support, output\n\"support\". If it is related to sales, output \"sales\".\n\"\"\"\n\nevent = {\n \"type\": \"response.create\",\n \"response\": {\n # Setting to \"none\" indicates the response is out of band,\n # and will not be added to the default conversation\n \"conversation\": \"none\",\n\n # Set metadata to help identify responses sent back from the model\n \"metadata\": { \"topic\": \"classification\" },\n\n # Set any other available response fields\n \"modalities\": [ \"text\" ],\n \"instructions\": prompt,\n },\n}\n\nws.send(json.dumps(event))\n```\n\nNow, when you listen for the [`response.done`](/docs/api-reference/realtime-server-events/response/done) server event, you can identify the result of your out-of-band response.\n\nCreate an out-of-band model response\n\n```javascript\nfunction handleEvent(e) {\n const serverEvent = JSON.parse(e.data);\n if (\n serverEvent.type === \"response.done\" &&\n serverEvent.response.metadata?.topic === \"classification\"\n ) {\n // this server event pertained to our OOB model response\n console.log(serverEvent.response.output[0]);\n }\n}\n\n// Listen for server messages (WebRTC)\ndataChannel.addEventListener(\"message\", handleEvent);\n\n// Listen for server messages (WebSocket)\n// ws.on(\"message\", handleEvent);\n```\n\n```python\ndef on_message(ws, message):\n server_event = json.loads(message)\n topic = \"\"\n\n # See if metadata is present\n try:\n topic = server_event.response.metadata.topic\n except AttributeError:\n print(\"topic not set\")\n \n if server_event.type == \"response.done\" and topic == \"classification\":\n # this server event pertained to our OOB model response\n print(server_event.response.output[0])\n```\n\n### Create a custom context for responses\n\nYou can also construct a custom context that the model will use to generate a response, outside the default/current conversation. This can be done using the `input` array on a [`response.create`](/docs/api-reference/realtime-client-events/response/create) client event. You can use new inputs, or reference existing input items in the conversation by ID.\n\nListen for out-of-band model response with custom context\n\n```javascript\nconst event = {\n type: \"response.create\",\n response: {\n conversation: \"none\",\n metadata: { topic: \"pizza\" },\n modalities: [ \"text\" ],\n\n // Create a custom input array for this request with whatever context\n // is appropriate\n input: [\n // potentially include existing conversation items:\n {\n type: \"item_reference\",\n id: \"some_conversation_item_id\"\n },\n {\n type: \"message\",\n role: \"user\",\n content: [\n {\n type: \"input_text\",\n text: \"Is it okay to put pineapple on pizza?\",\n },\n ],\n },\n ],\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nevent = {\n \"type\": \"response.create\",\n \"response\": {\n \"conversation\": \"none\",\n \"metadata\": { \"topic\": \"pizza\" },\n \"modalities\": [ \"text\" ],\n\n # Create a custom input array for this request with whatever \n # context is appropriate\n \"input\": [\n # potentially include existing conversation items:\n {\n \"type\": \"item_reference\",\n \"id\": \"some_conversation_item_id\"\n },\n\n # include new content as well\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Is it okay to put pineapple on pizza?\",\n }\n ],\n }\n ],\n },\n}\n\nws.send(json.dumps(event))\n```\n\n### Create responses with no context\n\nYou can also insert responses into the default conversation, ignoring all other instructions and context. Do this by setting `input` to an empty array.\n\nInsert no-context model responses into the default conversation\n\n```javascript\nconst prompt = `\nSay exactly the following:\nI'm a little teapot, short and stout! \nThis is my handle, this is my spout!\n`;\n\nconst event = {\n type: \"response.create\",\n response: {\n // An empty input array removes existing context\n input: [],\n instructions: prompt,\n },\n};\n\n// WebRTC data channel and WebSocket both have .send()\ndataChannel.send(JSON.stringify(event));\n```\n\n```python\nprompt = \"\"\"\nSay exactly the following:\nI'm a little teapot, short and stout! \nThis is my handle, this is my spout!\n\"\"\"\n\nevent = {\n \"type\": \"response.create\",\n \"response\": {\n # An empty input array removes all prior context\n \"input\": [],\n \"instructions\": prompt,\n },\n}\n\nws.send(json.dumps(event))\n```\n\nFunction calling\n----------------\n\nThe Realtime models also support **function calling**, which enables you to execute custom code to extend the capabilities of the model. Here's how it works at a high level:\n\n1. When [updating the session](/docs/api-reference/realtime-client-events/session/update) or [creating a response](/docs/api-reference/realtime-client-events/response/create), you can specify a list of available functions for the model to call.\n2. If when processing input, the model determines it should make a function call, it will add items to the conversation representing arguments to a function call.\n3. When the client detects conversation items that contain function call arguments, it will execute custom code using those arguments\n4. When the custom code has been executed, the client will create new conversation items that contain the output of the function call, and ask the model to respond.\n\nLet's see how this would work in practice by adding a callable function that will provide today's horoscope to users of the model. We'll show the shape of the client event objects that need to be sent, and what the server will emit in turn.\n\n### Configure callable functions\n\nFirst, we must give the model a selection of functions it can call based on user input. Available functions can be configured either at the session level, or the individual response level.\n\n* Session: `session.tools` property in [`session.update`](/docs/api-reference/realtime-client-events/session/update)\n* Response: `response.tools` property in [`response.create`](/docs/api-reference/realtime-client-events/response/create)\n\nHere's an example client event payload for a `session.update` that configures a horoscope generation function, that takes a single argument (the astrological sign for which the horoscope should be generated):\n\n[`session.update`](/docs/api-reference/realtime-client-events/session/update)\n\n```json\n{\n \"type\": \"session.update\",\n \"session\": {\n \"tools\": [\n {\n \"type\": \"function\",\n \"name\": \"generate_horoscope\",\n \"description\": \"Give today's horoscope for an astrological sign.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"sign\": {\n \"type\": \"string\",\n \"description\": \"The sign for the horoscope.\",\n \"enum\": [\n \"Aries\",\n \"Taurus\",\n \"Gemini\",\n \"Cancer\",\n \"Leo\",\n \"Virgo\",\n \"Libra\",\n \"Scorpio\",\n \"Sagittarius\",\n \"Capricorn\",\n \"Aquarius\",\n \"Pisces\"\n ]\n }\n },\n \"required\": [\"sign\"]\n }\n }\n ],\n \"tool_choice\": \"auto\",\n }\n}\n```\n\nThe `description` fields for the function and the parameters help the model choose whether or not to call the function, and what data to include in each parameter. If the model receives input that indicates the user wants their horoscope, it will call this function with a `sign` parameter.\n\n### Detect when the model wants to call a function\n\nBased on inputs to the model, the model may decide to call a function in order to generate the best response. Let's say our application adds the following conversation item and attempts to generate a response:\n\n[`conversation.item.create`](/docs/api-reference/realtime-client-events/conversation/item/create)\n\n```json\n{\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"What is my horoscope? I am an aquarius.\"\n }\n ]\n }\n}\n```\n\nFollowed by a client event to generate a response:\n\n[`response.create`](/docs/api-reference/realtime-client-events/response/create)\n\n```json\n{\n \"type\": \"response.create\"\n}\n```\n\nInstead of immediately returning a text or audio response, the model will instead generate a response that contains the arguments that should be passed to a function in the developer's application. You can listen for realtime updates to function call arguments using the [`response.function_call_arguments.delta`](/docs/api-reference/realtime-server-events/response/function_call_arguments/delta) server event, but `response.done` will also have the complete data we need to call our function.\n\n[`response.done`](/docs/api-reference/realtime-server-events/response/done)\n\n```json\n{\n \"type\": \"response.done\",\n \"event_id\": \"event_AeqLA8iR6FK20L4XZs2P6\",\n \"response\": {\n \"object\": \"realtime.response\",\n \"id\": \"resp_AeqL8XwMUOri9OhcQJIu9\",\n \"status\": \"completed\",\n \"status_details\": null,\n \"output\": [\n {\n \"object\": \"realtime.item\",\n \"id\": \"item_AeqL8gmRWDn9bIsUM2T35\",\n \"type\": \"function_call\",\n \"status\": \"completed\",\n \"name\": \"generate_horoscope\",\n \"call_id\": \"call_sHlR7iaFwQ2YQOqm\",\n \"arguments\": \"{\\\"sign\\\":\\\"Aquarius\\\"}\"\n }\n ],\n \"usage\": {\n \"total_tokens\": 541,\n \"input_tokens\": 521,\n \"output_tokens\": 20,\n \"input_token_details\": {\n \"text_tokens\": 292,\n \"audio_tokens\": 229,\n \"cached_tokens\": 0,\n \"cached_tokens_details\": { \"text_tokens\": 0, \"audio_tokens\": 0 }\n },\n \"output_token_details\": {\n \"text_tokens\": 20,\n \"audio_tokens\": 0\n }\n },\n \"metadata\": null\n }\n}\n```\n\nIn the JSON emitted by the server, we can detect that the model wants to call a custom function:\n\n|Property|Function calling purpose|\n|---|---|\n|response.output[0].type|When set to function_call, indicates this response contains arguments for a named function call.|\n|response.output[0].name|The name of the configured function to call, in this case generate_horoscope|\n|response.output[0].arguments|A JSON string containing arguments to the function. In our case, \"{\\\"sign\\\":\\\"Aquarius\\\"}\".|\n|response.output[0].call_id|A system-generated ID for this function call - you will need this ID to pass a function call result back to the model.|\n\nGiven this information, we can execute code in our application to generate the horoscope, and then provide that information back to the model so it can generate a response.\n\n### Provide the results of a function call to the model\n\nUpon receiving a response from the model with arguments to a function call, your application can execute code that satisfies the function call. This could be anything you want, like talking to external APIs or accessing databases.\n\nOnce you are ready to give the model the results of your custom code, you can create a new conversation item containing the result via the `conversation.item.create` client event.\n\n[`conversation.item.create`](/docs/api-reference/realtime-client-events/conversation/item/create)\n\n```json\n{\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"function_call_output\",\n \"call_id\": \"call_sHlR7iaFwQ2YQOqm\",\n \"output\": \"{\\\"horoscope\\\": \\\"You will soon meet a new friend.\\\"}\"\n }\n}\n```\n\n* The conversation item type is `function_call_output`\n* `item.call_id` is the same ID we got back in the `response.done` event above\n* `item.output` is a JSON string containing the results of our function call\n\nOnce we have added the conversation item containing our function call results, we again emit the `response.create` event from the client. This will trigger a model response using the data from the function call.\n\n[`response.create`](/docs/api-reference/realtime-client-events/response/create)\n\n```json\n{\n \"type\": \"response.create\"\n}\n```\n\nError handling\n--------------\n\nThe [`error`](/docs/api-reference/realtime-server-events/error) event is emitted by the server whenever an error condition is encountered on the server during the session. Occasionally, these errors can be traced to a client event that was emitted by your application.\n\nUnlike HTTP requests and responses, where a response is implicitly tied to a request from the client, we need to use an `event_id` property on client events to know when one of them has triggered an error condition on the server. This technique is shown in the code below, where the client attempts to emit an unsupported event type.\n\n```javascript\nconst event = {\n event_id: \"my_awesome_event\",\n type: \"scooby.dooby.doo\",\n};\n\ndataChannel.send(JSON.stringify(event));\n```\n\nThis unsuccessful event sent from the client will emit an error event like the following:\n\n```json\n{\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_value\",\n \"message\": \"Invalid value: 'scooby.dooby.doo' ...\",\n \"param\": \"type\",\n \"event_id\": \"my_awesome_event\"\n}\n```\n\nWas this page useful?",[],[202,294,345],"ab379980-895f-11f0-a0eb-0224a6c84d84",["D",1756970443473],[219,220,221,222,223,224,225,226,227],[202,294],["D",1756970443473],[218],[202],["D",1756970443473],{"_106":105,"_113":109},{"_106":105,"_107":-5,"_108":109,"_18":61,"_110":111,"_112":55},{"_13":91,"_33":92,"_49":41,"_93":50,"_94":95,"_96":97,"_98":57,"_99":100,"_101":102,"_103":51,"_104":105},"ctx",{"_84":-5,"_135":395,"_396":397,"_398":399,"_400":55,"_401":55,"_402":55,"_403":26,"_404":-5,"_405":-7,"_406":-7,"_407":68,"_408":55,"_409":55,"_410":-5,"_411":55,"_412":55,"_413":55,"_414":-5},"ENV",{"_366":367,"_368":369,"_370":92,"_371":372,"_373":374,"_375":376,"_377":378,"_379":380,"_381":382,"_383":384,"_385":386,"_387":388,"_389":390,"_391":392,"_393":394},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","e87eb04e707cf64e7e532c8e8ec395f209e17f15","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]

Diff · v16