Skip to Content
Referencia de la APIProtocolo compatible con OpenAIDescripción general

Protocolo compatible con OpenAI

Con el SDK oficial de OpenAI o cualquier cliente compatible con OpenAI, basta con cambiar la URL de la API por la de OfoxAI e introducir su API Key de OfoxAI.

URL de la APIhttps://api.ofox.io/v1
Encabezado de autenticaciónAuthorization: Bearer <su OFOXAI_API_KEY>

Endpoints

Para las solicitudes de conversación, se recomienda usar Responses (la interfaz que OpenAI recomienda actualmente, con mejor soporte de caché de prompts). El código existente basado en Chat Completions puede mantenerse sin cambios: solo es necesario cambiar la URL y la API Key.

EndpointMétodo y rutaUso
Chat CompletionsPOST /v1/chat/completionsCompletado de conversaciones; la opción más compatible con el código existente
ResponsesPOST /v1/responsesInterfaz de conversación de nueva generación; recomendada
EmbeddingsPOST /v1/embeddingsVectores de texto
ImagesPOST /v1/images/generations, /v1/images/editsGeneración y edición de imágenes
ModelsGET /v1/modelsLista de modelos disponibles y sus detalles
Models CountGET /v1/models/countRecuento de modelos

Para comparar la URL y la autenticación de los tres protocolos, consulte la Descripción general de la API. Para obtener y guardar la API Key, consulte Obtención y uso de la API Key.

Last updated on