Saltar al contenido
Referencia de API
Referencia de API

OpenAI Live

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

Ver Markdown
01

Descripción general

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

Inicio rápido

  1. Cree una Clave de API y establézcala como RUNAPI_API_KEY.
  2. Elija un modelo compatible y envíe los parámetros de ruta y el cuerpo JSON documentados.
  3. Lea la respuesta JSON o los eventos enviados por el servidor que se muestran para esta operación y gestione los errores de protocolo.

Endpoint

POST /v1/live/webrtc
URL base
https://runapi.ai
Versión del contrato
v1
Autenticación preferida
Authorization: Bearer YOUR_API_TOKEN
02

Portadores de autenticación

RunAPI acepta cada uno de los carriers indicados a continuación. Los ejemplos generados utilizan el encabezado preferido del protocolo.

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

Modelos compatibles

Abra una página de modelo para conocer los precios actuales, los límites de velocidad y los detalles de uso comercial.

Mostrar 1 modelo compatible
04

Contrato de solicitud

Cuerpo JSON

Solo se enumeran los campos con evidencia de protocolo público y compatibilidad con RunAPI. Los campos adicionales del cuerpo JSON se transmiten tal cual.

Cuerpo JSON15 campos
delegation["object", "null"]
Opcional

Optional client or Responses delegation contract.

delegation.instructionsstring
Opcional

Backend prompt for delegated work when type is responses.

delegation.max_output_tokensinteger
Opcional

Output token budget for the delegated response.

delegation.modelstring
Opcional

Responses model that runs delegated work when type is responses.

delegation.parallel_tool_callsboolean
Opcional

Allow independent delegated tool calls in one turn.

delegation.reasoningobject
Opcional

Reasoning settings for the delegated model.

delegation.service_tierstring
Opcional

Service tier requested for the delegated response.

delegation.textobject
Opcional

Text output settings for the delegated response.

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

Which delegated tools the backend may use.

delegation.toolsarray
Opcional

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

delegation.tools[].typestring
Obligatorio
delegation.typestring
Opcional Valores permitidos: client, responses
modelstring
Obligatorio

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

sdpstring
Obligatorio

Client SDP offer for the WebRTC session.

transportstring
Obligatorio

WebRTC session negotiation transport.

Ejemplo de solicitud

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

Respuesta síncrona

HTTP 201

Esquema

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

Ejemplo

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

Error de protocolo: invalid_request

HTTP 400

Esquema

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

Ejemplo

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

Uso

Esquema

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

Ejemplo

JSON 
{
  "duration_seconds": 3
}
08

Ejemplos de código generados

Cada muestra de cURL, JavaScript y Python envía la solicitud validada de este contrato sin requerir un SDK específico del protocolo.

Instalar

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())