OpenAPI e índice de endpoints

El contrato público legible por máquinas está disponible en OpenAPI 3.1 YAML. Úsalo para generar un cliente o validar tu integración con los endpoints públicos actuales.

Estas API de la plataforma permiten seleccionar modelos, calcular estimaciones y supervisar el gasto sin abrir la consola. El catálogo de modelos incluye los precios de tu cuenta; utiliza una cotización para las entradas exactas cuando el precio dependa de los parámetros. El historial de tareas y el uso se limitan a la clave de API con la que haces la llamada. La creación y rotación de claves y la configuración de presupuestos siguen realizándose en la consola. Cada tabla enlaza a la guía que explica el endpoint completo.

Descubrimiento de modelos, precios y API de cuenta

API de generación y tareas

API de medios

Autenticación y formato de respuestas

Todos los endpoints salvo el catálogo público requieren tu clave de API como Authorization: Bearer sk-spicy-…; los endpoints de compatibilidad (/v1, /v1beta) también aceptan x-api-key, enviado por los SDK de Anthropic, y x-goog-api-key, enviado por los SDK de Google GenAI. Nunca se acepta una clave en la cadena de consulta de la URL. Las tareas, los reintentos, las eliminaciones de contenido y los enlaces de descarga solo son visibles para la clave de API que creó la tarea; consulta Autenticación.

Las respuestas JSON de la API de tareas comparten el formato {code,msg,data,request_id}; los endpoints de compatibilidad utilizan los formatos de sus propios protocolos. El resultado de una tarea se expresa en data.state, no en el code del formato externo. Consulta Errores.

Encabezados utilizados en distintos endpoints

Uso del archivo OpenAPI

• Probar solicitudes sin escribir código: importa el archivo OpenAPI enlazado al principio de esta página en un cliente de API como Postman, Insomnia o Bruno y configura tu clave de API como token bearer. Recuerda que crear tareas cuesta dinero.
• Generar un cliente: proporciona el mismo archivo a un generador de código compatible con OpenAPI 3.1 para tu lenguaje.

Cambios del contrato

• No guardes los parámetros de los modelos como una copia permanente fijada en el código; lee inputSchema desde /models/{model}.
• Tolera los campos desconocidos en las respuestas, pero nunca supongas qué campos desconocidos puedes enviar en una solicitud.
• Utiliza el YAML de OpenAPI para generar código o ejecutar pruebas del contrato antes de publicar.

Endpoints de compatibilidad

Los endpoints de texto se explican en Texto y streaming; su facturación se describe en Cotizaciones y compatibilidad.

El paquete oficial de TypeScript es @spicyapi/sdk. Para Python y Go, o si no puedes añadir una dependencia, los clientes de referencia que puedes copiar a continuación llaman a estos endpoints usando únicamente el entorno de ejecución del lenguaje. El cliente de Python gestiona una tarea completa de medios: sube y confirma un archivo de referencia, comprueba el precio mediante una cotización, crea la tarea y consulta su estado hasta que finaliza, lee el resultado tanto si contiene archivos como texto, renueva un enlace de salida vencido, destruye después el contenido almacenado y verifica una firma de webhook. El de Go cubre el mismo proceso, con un contexto en cada llamada y un error tipado que se recupera mediante errors.As. El de TypeScript cubre la creación, el reintento, la consulta del estado y la espera con límite; para las subidas y el resto de los endpoints en Node.js, utiliza el SDK.

Clientes de referencia copiables

Ejemplos sin dependencias para descubrir modelos, crear tareas, reintentar tareas fallidas, consultar todos los estados terminales, limitar la espera y tratar la idempotencia y los errores. Una tarea aceptada no se puede cancelar.

Cliente TypeScript de referenciaCliente Python de referenciaCliente Go de referenciaREADME

Son ejemplos de documentación, no paquetes npm o PyPI ni módulos Go publicados. Diez minutos es un límite local, no un SLA.