Descripción general de la API

OfoxAI ofrece tres protocolos de acceso API, totalmente compatibles con los SDKs oficiales de cada proveedor.

Recomendación de protocolo: para el protocolo OpenAI, recomendamos la Responses API, con mejor soporte nativo de Prompt Caching; para los modelos Claude, recomendamos el protocolo nativo de Anthropic, con todas las funciones y caché nativa.

Base URL

Protocolo	Base URL	Descripción
Compatible con OpenAI	`https://api.ofox.io/v1`	Compatible con el SDK de OpenAI, soporta todos los modelos
Nativo Anthropic	`https://api.ofox.io/anthropic`	Compatible con el SDK de Anthropic, experiencia nativa de Claude
Nativo Gemini	`https://api.ofox.io/gemini`	Compatible con el SDK de Google GenAI

Autenticación

Todos los protocolos utilizan una API Key unificada de OfoxAI, pero el formato del Header varía según el protocolo:

Protocolo	Header	Formato
OpenAI	`Authorization`	`Bearer sk-xxx`
Anthropic	`x-api-key`	`sk-xxx`
Gemini	`x-goog-api-key`	`sk-xxx`

Consulte Obtención y uso de la API Key para más detalles.

Endpoints disponibles

Protocolo compatible con OpenAI

Endpoint	Método	Descripción
`/v1/chat/completions`	POST	Crear completación de chat
`/v1/embeddings`	POST	Crear embeddings de texto
`/v1/models`	GET	Listar modelos disponibles
`/v1/models/{model_id}`	GET	Obtener detalles del modelo
`/v1/images/generations`	POST	Generación de imágenes

Protocolo nativo Anthropic

Endpoint	Método	Descripción
`/anthropic/v1/messages`	POST	Crear Messages

Protocolo nativo Gemini

Endpoint	Método	Descripción
`/gemini/v1beta/models/{model}:generateContent`	POST	Generar contenido
`/gemini/v1beta/models/{model}:streamGenerateContent`	POST	Generar contenido en streaming

Decisiones tipadas

Permite tomar decisiones de sí/no, de opción única y de puntuación sobre un contenido y obtener respuestas estructuradas con probabilidades. Consulta la documentación de Decisions API.

Endpoint	Método	Descripción
`/v1/decisions`	POST	Formato unificado; también se puede llamar con el SDK de OpenAI
`/openai/v1/decisions`	POST	Igual que el anterior, para configuraciones del SDK de OpenAI cuya URL base es `/openai/v1`
`/typesafe/v1/systemone`	POST	Formato oficial de TypeSafe, compatible con el SDK de TypeSafe

Generación de video (compatible con OpenRouter)

API unificada de generación de video asíncrona. Consulta la documentación de Video API.

Endpoint	Método	Descripción
`/v1/videos`	POST	Crear una tarea de generación de video
`/v1/videos/{id}`	GET	Obtener el estado y resultado de la tarea
`/v1/videos/{id}`	DELETE	Cancelar una tarea

OfoxAI OpenAPI (Cuenta)

Endpoints de plataforma independientes del protocolo, autenticados con la API Key de OfoxAI.

Endpoint	Método	Descripción
`/v1/user/balance`	GET	Consulta de saldo, compatible con cc-switch

Límites de tasa

OfoxAI funciona con pago por uso. Todos los usuarios comparten la misma política de tasa, sin diferencias por plan:

Límite	Cuota
RPM (solicitudes/minuto)	100 (agregado por equipo)
TPM (tokens/minuto)	Sin límite

El RPM se calcula de forma agregada a nivel de equipo: varias API Keys del mismo equipo comparten una única cuota. Si necesita una cuota de RPM más alta, contacte a hi@ofox.ai para solicitar un ajuste.

Cuando se activa el límite de tasa, la API retorna 429 Too Many Requests con los siguientes Headers de respuesta:


x-ratelimit-limit-requests: 100
x-ratelimit-remaining-requests: 0
x-ratelimit-reset-requests: 1s

Códigos de error

Todos los protocolos retornan códigos de estado HTTP unificados:

Código	Descripción	Causa común
`200`	Éxito	—
`400`	Error de solicitud	Formato de parámetros incorrecto, campos obligatorios faltantes
`401`	Autenticación fallida	API Key inválida o expirada
`403`	Permisos insuficientes	La cuenta no tiene acceso a este modelo
`404`	Recurso no encontrado	ID de modelo incorrecto
`429`	Límite de tasa alcanzado	Se excedió el límite de tasa
`500`	Error del servidor	Error interno, intente de nuevo
`502`	Error upstream	Servicio del proveedor de modelos con problemas
`503`	Servicio no disponible	Servicio en mantenimiento

Formato de respuesta de error


{
  "error": {
    "code": "invalid_api_key",
    "message": "La API Key proporcionada no es válida. Por favor, verifíquela e intente de nuevo.",
    "type": "authentication_error"
  }
}

Parámetros extendidos de OfoxAI

OfoxAI ofrece parámetros extendidos sobre los protocolos estándar para control avanzado de enrutamiento y respaldo:


{
  "model": "openai/gpt-6.1-sol",
  "messages": [...],
  "extra_body": {
    "provider": {
      "fallback": ["anthropic/claude-sonnet-5.5", "google/gemini-3.8-flash"]
    }
  }
}

provider debe ubicarse dentro de extra_body en el cuerpo de la solicitud; si se coloca en el nivel superior, la solicitud devuelve 400. Consulte enrutamiento de proveedores y respaldo automático para más detalles.