Skip to content
API Reference
API Reference

OpenAI Live

Send a request through RunAPI's OpenAI-compatible Live operation.

View Markdown
01

Overview

Use RunAPI's OpenAI-compatible Live operation with a compatible model and the protocol's request and response shapes.

Quick start

  1. Create an API key and set it as RUNAPI_API_KEY.
  2. Choose a compatible model, then send the documented path parameters and JSON body.
  3. Read the JSON response or server-sent events shown for this operation, and handle protocol errors.

Endpoint

POST /v1/live/webrtc
Base URL
https://runapi.ai
Contract version
v1
Preferred authentication
Authorization: Bearer YOUR_API_TOKEN
02

Authentication carriers

RunAPI accepts each carrier listed below. Generated samples use the protocol's preferred header.

header - Preferred
Authorization: Bearer YOUR_API_TOKEN
header
x-api-key: YOUR_API_TOKEN
03

Compatible models

Open a model page for current pricing, rate limits, and commercial-usage details.

Show 1 compatible model
04

Request contract

JSON body

Only fields with both public protocol and RunAPI support evidence are listed. Additional JSON body fields are passed through.

JSON body15 fields
delegation["object", "null"]
Optional

Optional client or Responses delegation contract.

delegation.instructionsstring
Optional

Backend prompt for delegated work when type is responses.

delegation.max_output_tokensinteger
Optional

Output token budget for the delegated response.

delegation.modelstring
Optional

Responses model that runs delegated work when type is responses.

delegation.parallel_tool_callsboolean
Optional

Allow independent delegated tool calls in one turn.

delegation.reasoningobject
Optional

Reasoning settings for the delegated model.

delegation.service_tierstring
Optional

Service tier requested for the delegated response.

delegation.textobject
Optional

Text output settings for the delegated response.

delegation.tool_choice["string", "object"]
Optional

Which delegated tools the backend may use.

delegation.toolsarray
Optional

Hosted Responses tools, or client-owned function tools when type is client.

delegation.tools[].typestring
Required
delegation.typestring
Optional Allowed values: client, responses
modelstring
Required

RunAPI model identifier; Live currently supports gpt-live-1.

sdpstring
Required

Client SDP offer for the WebRTC session.

transportstring
Required

WebRTC session negotiation transport.

Request example

JSON 
{
  "delegation": {
    "model": "gpt-5.6-terra",
    "tools": [
      {
        "type": "web_search_preview"
      }
    ],
    "type": "responses"
  },
  "model": "gpt-live-1",
  "sdp": "v=0",
  "transport": "webrtc"
}
05

Synchronous response

HTTP 201

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "session": {
      "additionalProperties": true,
      "type": "object"
    },
    "transport": {
      "additionalProperties": true,
      "type": "object"
    }
  },
  "required": [
    "session",
    "transport"
  ],
  "type": "object"
}

Example

JSON 
{
  "session": {
    "id": "live_123"
  },
  "transport": {
    "sdp": "answer",
    "type": "webrtc"
  }
}
06

Protocol error: invalid_request

HTTP 400

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Example

JSON 
{
  "error": {
    "code": null,
    "message": "Invalid Live session request",
    "param": "sdp",
    "type": "invalid_request_error"
  }
}
07

Usage

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "duration_seconds": {
      "type": "number"
    }
  },
  "required": [
    "duration_seconds"
  ],
  "type": "object"
}

Example

JSON 
{
  "duration_seconds": 3
}
08

Generated Code Samples

Each cURL, JavaScript, and Python sample sends the validated request from this contract without requiring a protocol-specific SDK.

Install

Shell 
pip install requests
PYTHON 
import requests

response = requests.post(
    "https://runapi.ai/v1/live/webrtc",
    headers={"Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json"},
    json={"model": "gpt-live-1", "transport": "webrtc", "sdp": "v=0", "delegation": {"type": "responses", "model": "gpt-5.6-terra", "tools": [{"type": "web_search_preview"}]}}
)
response.raise_for_status()
print(response.json())