Naar inhoud springen
API-referentie
API-referentie

OpenAI Live

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

Markdown bekijken
01

Overzicht

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

Snelstart

  1. Maak een API-sleutel aan en stel deze in als RUNAPI_API_KEY.
  2. Kies een compatibel model en stuur de gedocumenteerde padparameters en JSON-body.
  3. Lees de JSON-respons of server-sent events die voor deze bewerking worden weergegeven, en handel protocollfouten af.

Eindpunt

POST /v1/live/webrtc
Basis-URL
https://runapi.ai
Contractversie
v1
Voorkeursauthenticatie
Authorization: Bearer YOUR_API_TOKEN
02

Authenticatiedragers

RunAPI accepteert elke hieronder vermelde carrier. Gegenereerde voorbeelden gebruiken de voorkeurskoptekst van het protocol.

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

Compatibele modellen

Open een modelpagina voor actuele prijzen, snelheidslimieten en details over commercieel gebruik.

Toon 1 compatibel model
04

Verzoekcontract

JSON-body

Alleen velden met zowel openbaar protocol als bewijs van RunAPI-ondersteuning worden vermeld. Aanvullende JSON-bodyvelden worden doorgegeven.

JSON-body18 velden
delegation["object", "null"]
Optioneel

Optioneel client- of Responses-delegatiecontract, in het formaat van de provider.

delegation.responsesobject
Optioneel

Backend-instellingen voor gedelegeerd werk wanneer type responses is.

delegation.responses.instructionsstring
Optioneel

Backend-prompt voor gedelegeerd werk.

delegation.responses.max_output_tokensinteger
Optioneel

Uitvoertokenbudget voor het gedelegeerde antwoord; minimaal 16.

delegation.responses.modelstring
Verplicht

Responses-model dat het gedelegeerde werk uitvoert.

delegation.responses.parallel_tool_callsboolean
Optioneel

Allow independent delegated tool calls in one turn.

delegation.responses.reasoningobject
Optioneel

Reasoning settings for the delegated model.

delegation.responses.service_tierstring
Optioneel

Service tier requested for the delegated response.

delegation.responses.textobject
Optioneel

Text output settings for the delegated response.

delegation.responses.tool_choice["string", "object"]
Optioneel

Which delegated tools the backend may use.

delegation.responses.toolsarray
Optioneel

Gehoste Responses-tools die de gedelegeerde aanroep mag gebruiken.

delegation.responses.tools[].typestring
Verplicht Toegestane waarden: web_search, web_search_preview, file_search, computer_use_preview
delegation.toolsarray
Optioneel

Function-tools in eigendom van de client wanneer type client is.

delegation.tools[].typestring
Verplicht
delegation.typestring
Optioneel Toegestane waarden: client, responses
modelstring
Verplicht

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

sdpstring
Verplicht

Client SDP offer for the WebRTC session.

transportstring
Verplicht

WebRTC session negotiation transport.

Verzoekvoorbeeld

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

Synchroon antwoord

HTTP 201

Schema

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

Voorbeeld

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

Protocolfout: 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"
}

Voorbeeld

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

Gebruik

Schema

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

Voorbeeld

JSON 
{
  "duration_seconds": 3
}
08

Gegenereerde codevoorbeelden

Elk cURL-, JavaScript- en Python-voorbeeld verstuurt de gevalideerde aanvraag uit dit contract zonder dat een protocolspecifieke SDK vereist is.

Installeren

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", "responses": {"model": "gpt-5.6-terra", "tools": [{"type": "web_search"}]}}}
)
response.raise_for_status()
print(response.json())