Saltar al contenido
Referencia de API
Referencia de API

OpenAI Chat Completions

Envíe una solicitud a través de la operación Chat Completions compatible con OpenAI de RunAPI.

Ver Markdown
01

Descripción general

Usa la operación Chat Completions compatible con OpenAI de RunAPI con un modelo compatible y las formas de solicitud y respuesta del protocolo.

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/chat/completions
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
header
x-goog-api-key: YOUR_API_TOKEN
query
?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 60 modelos compatibles
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 JSON9 campos
max_tokens["integer", "null"]
Opcional

Límite de tokens de generación de compatibilidad conservado para los modelos compatibles; la compatibilidad con los modelos puede variar.

messagesarray
Obligatorio

Mensajes de conversación en formato OpenAI Chat Completions.

messages[].content["string", "array"]
Opcional
messages[].rolestring
Obligatorio
modelstring
Obligatorio

Identificador de modelo de RunAPI devuelto por el catálogo de modelos compatible.

stream["boolean", "null"]
Opcional

Devolver fragmentos de Chat Completions como eventos enviados por el servidor.

Valor predeterminado: false
temperature["number", "null"]
Opcional

Temperatura de muestreo; la compatibilidad puede variar según el modelo.

toolsarray
Opcional

Herramientas que el modelo puede llamar.

top_p["number", "null"]
Opcional

Probabilidad de muestreo de núcleo; la compatibilidad con el modelo puede variar.

Ejemplo de solicitud

JSON 
{
  "messages": [
    {
      "content": "Summarize one practical improvement for an API deployment.",
      "role": "user"
    }
  ],
  "model": "gpt-5.4",
  "stream": false
}
05

Respuesta síncrona

HTTP 200

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "choices": {
      "type": "array"
    },
    "created": {
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "object": {
      "const": "chat.completion",
      "type": "string"
    },
    "usage": {
      "additionalProperties": true,
      "properties": {
        "completion_tokens": {
          "type": "integer"
        },
        "prompt_tokens": {
          "type": "integer"
        },
        "total_tokens": {
          "type": "integer"
        }
      },
      "required": [
        "prompt_tokens",
        "completion_tokens",
        "total_tokens"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "object",
    "created",
    "model",
    "choices"
  ],
  "type": "object"
}

Ejemplo

JSON 
{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "content": "Hello! How can I help today?",
        "role": "assistant"
      }
    }
  ],
  "created": 1785196800,
  "id": "chatcmpl_example",
  "model": "gpt-5.4",
  "object": "chat.completion",
  "usage": {
    "completion_tokens": 8,
    "prompt_tokens": 12,
    "total_tokens": 20
  }
}
06

Evento SSE: chunk

text/event-stream

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "choices": {
      "type": "array"
    },
    "created": {
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "object": {
      "const": "chat.completion.chunk",
      "type": "string"
    },
    "usage": {
      "oneOf": [
        {
          "additionalProperties": true,
          "properties": {
            "completion_tokens": {
              "type": "integer"
            },
            "prompt_tokens": {
              "type": "integer"
            },
            "total_tokens": {
              "type": "integer"
            }
          },
          "required": [
            "prompt_tokens",
            "completion_tokens",
            "total_tokens"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "object",
    "choices"
  ],
  "type": "object"
}

Ejemplo

JSON 
{
  "choices": [
    {
      "delta": {
        "content": "Hello"
      },
      "finish_reason": null,
      "index": 0
    }
  ],
  "id": "chatcmpl_example",
  "object": "chat.completion.chunk",
  "usage": null
}
07

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": "messages is required",
    "param": "messages",
    "type": "invalid_request_error"
  }
}
08

Uso

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "completion_tokens": {
      "type": "integer"
    },
    "prompt_tokens": {
      "type": "integer"
    },
    "total_tokens": {
      "type": "integer"
    }
  },
  "required": [
    "prompt_tokens",
    "completion_tokens",
    "total_tokens"
  ],
  "type": "object"
}

Ejemplo

JSON 
{
  "completion_tokens": 8,
  "prompt_tokens": 12,
  "total_tokens": 20
}
09

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/chat/completions",
    headers={"Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json"},
    json={"model": "gpt-5.4", "messages": [{"role": "user", "content": "Summarize one practical improvement for an API deployment."}], "stream": False}
)
response.raise_for_status()
print(response.json())