API de Orkas

Documentación de la API de Orkas

Conecta las funciones de chat, búsqueda, voz, imágenes y video de Orkas a tus propias herramientas. Empieza por Chat para encontrar la URL base, la clave de API y los nombres de modelos que usa la mayoría de las aplicaciones de IA.

Crear clave de API

Chat

Usa el formato Chat Completions compatible con OpenAI en aplicaciones de IA, herramientas de línea de comandos o tu propio servicio.

Configuración de conexión

Si una aplicación solicita una URL base, una clave de API y un modelo, introduce los siguientes valores.

Ajuste	Valor	Descripción
`Base URL`	`https://orkas.ai/v1`	Usa esta dirección para el servicio compatible con OpenAI.
`API Key`	Crear una clave en Cuenta	Pega la clave en el campo de clave de API de la aplicación.
`model`	`orkas-llm-1.5`Recomendado	Ideal para preguntas y respuestas cotidianas, redacción y trabajo de oficina. Incluye DeepSeek V4 · GPT-5.6 Luna · Claude-Sonnet-5 · Gemini-3.6 Flash.
`model`	`orkas-llm-1.5-pro`	Ideal para investigación, video, I+D y otras tareas complejas. Incluye GPT-5.6 Sol · Claude Opus 5 · Kimi K3.

Crear una respuesta de chat

Endpoint

POST

https://orkas.ai/v1/chat/completions

Crear una respuesta de chat

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Descripción
`model`	string	Sí	`orkas-llm-1.5` o `orkas-llm-1.5-pro`.
`messages`	array	Sí	Mensajes de la conversación. Cada elemento contiene `role` y `content`.
`stream`	boolean	No	Devuelve una respuesta en streaming cuando el valor es `true`. Valor predeterminado: `false`.

Ejemplo de solicitud

curl https://orkas.ai/v1/chat/completions \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "orkas-llm-1.5",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Consumo de créditos

Concepto de facturación	Créditos descontados	Unidad de facturación
`orkas-llm-1.5`	Entrada 20–280; lectura de caché 2–28; creación de caché 25–350; salida 120–1260	Por 1M de tokens; la tarifa exacta depende de la solicitud.
`orkas-llm-1.5-pro`	Entrada 140–1000; lectura de caché 14–100; creación de caché 175–1250; salida 840–4500	Por 1M de tokens; la tarifa exacta depende de la solicitud.

Búsqueda

Busca en la web y devuelve una lista compacta de resultados relevantes para tu aplicación.

Buscar en la web

Endpoint

POST

https://orkas.ai/v1/search

Buscar en la web

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Descripción
`query`	string	Sí	Texto de búsqueda, hasta 2000 caracteres.
`max_results`	integer	No	Número de resultados, 1–20. Valor predeterminado: `8`.

Ejemplo de solicitud

curl https://orkas.ai/v1/search \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"latest battery research","max_results":8}'

Consumo de créditos

Concepto de facturación	Créditos descontados	Unidad de facturación
Buscar en la web	5.6	Por solicitud, con hasta 20 resultados.

Voz

Convierte texto en un archivo de audio. Elige un ID de voz de la lista siguiente y selecciona el formato de audio que necesites.

Listar voces

Endpoint

GET

https://orkas.ai/v1/audio/voices

Listar voces

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros de la solicitud

Este endpoint no tiene parámetros de solicitud.

Ejemplo de solicitud

curl https://orkas.ai/v1/audio/voices \
  -H "Authorization: Bearer $ORKAS_API_KEY"

ID de voces disponibles

ID de voz	Nombre	Idioma
`zh_female_vv_uranus_bigtts`	vivi 2.0	Chino / Inglés
`saturn_zh_female_cancan_tob`	知性灿灿	Chino
`saturn_zh_female_keainvsheng_tob`	可爱女生	Chino
`saturn_zh_female_tiaopigongzhu_tob`	调皮公主	Chino
`saturn_zh_male_shuanglangshaonian_tob`	爽朗少年	Chino
`saturn_zh_male_tiancaitongzhuo_tob`	天才同桌	Chino
`zh_female_xiaohe_uranus_bigtts`	小何	Chino
`zh_male_m191_uranus_bigtts`	云舟	Chino
`zh_male_taocheng_uranus_bigtts`	小天	Chino
`en_male_tim_uranus_bigtts`	Tim	Inglés
`en_female_dacey_uranus_bigtts`	Dacey	Inglés
`en_female_stokie_uranus_bigtts`	Stokie	Inglés

Generar voz

Endpoint

POST

https://orkas.ai/v1/audio/speech

Generar voz

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Descripción
`model`	string	Sí	Usa `orkas-tts-1`.
`input`	string	Sí	Texto que se sintetizará, hasta 16384 bytes UTF-8.
`voice`	string	Sí	ID de voz de la lista anterior.
`language`	string	No	Idioma de narración, como `zh-CN` o `en`. Debe ser compatible con la voz seleccionada; de lo contrario, se usa el idioma predeterminado de la voz.
`response_format`	string	No	`mp3`, `wav`, `opus` u `ogg`. Valor predeterminado: `mp3`.
`speed`	number	No	Velocidad de voz de 0.5 a 2.0. Valor predeterminado: `1.0`.

Ejemplo de solicitud

curl https://orkas.ai/v1/audio/speech \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model":"orkas-tts-1",
    "input":"你好，欢迎使用 Orkas。",
    "voice":"zh_female_vv_uranus_bigtts",
    "language":"zh-CN",
    "response_format":"mp3",
    "speed":1.0
  }' --output speech.mp3

Consumo de créditos

Concepto de facturación	Créditos descontados	Unidad de facturación
Listar voces	0	Por solicitud
Generar voz	0.125	Por segundo estimado de salida, redondeado hacia arriba con un mínimo de un segundo.

Imágenes

Genera una imagen a partir de una descripción o proporciona imágenes de referencia para editarla. Se devuelve una imagen por solicitud.

Generar una imagen

Endpoint

POST

https://orkas.ai/v1/images/generations

Generar una imagen

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Descripción
`prompt`	string	Sí	Descripción de la imagen, hasta 20000 caracteres.
`size`	string	No	`2k`, `3k`, `4k` o un valor de ancho×alto compatible. Valor predeterminado: `2k`.
`response_format`	string	No	`url` o `b64_json`. Valor predeterminado: `b64_json`.
`reference_images`	array	No	Hasta cuatro URL HTTPS o URL de datos de imagen compatibles para la edición.
`async`	boolean	No	Devuelve un ID de tarea cuando el valor es `true`. Se recomienda para evitar que las solicitudes superen el tiempo de espera. Valor predeterminado: `false`.

Ejemplo de solicitud

curl https://orkas.ai/v1/images/generations \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt":"A product photo on a clean studio background",
    "size":"2k",
    "response_format":"url",
    "async":true
  }'

Para solicitudes más largas: establece "async": true. La API devuelve un id de tarea; usa la URL de estado hasta que el resultado esté listo.

Consultar el estado de generación

Endpoint

GET

https://orkas.ai/v1/images/generations/{id}

Consultar el estado de generación

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	ID de tarea devuelto por la solicitud de creación.

Ejemplo de solicitud

curl https://orkas.ai/v1/images/generations/$TASK_ID \
  -H "Authorization: Bearer $ORKAS_API_KEY"

Consumo de créditos

Concepto de facturación	Créditos descontados	Unidad de facturación
Generar una imagen	22	Por imagen generada
Consultar el estado de generación	0	Por solicitud

Videos

Crea un video a partir de texto o contenido multimedia de referencia. Las solicitudes de video se ejecutan de forma asíncrona, así que usa el ID de tarea devuelto para consultar el progreso.

Crear un video

Endpoint

POST

https://orkas.ai/v1/videos

Crear un video

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Descripción
`prompt`	string	Sí	Descripción del video que se generará o editará.
`duration`	integer	No	4–15 segundos. Valor predeterminado: `5`.
`resolution`	string	No	`480p`, `720p` o `1080p`. Valor predeterminado: `720p`.
`quality`	string	No	`balanced` equilibra la velocidad y el consumo de créditos; `quality` prioriza la calidad y la estabilidad de la generación. Valor predeterminado: `balanced`. Orkas sigue seleccionando automáticamente el modelo de video compatible.
`ratio`	string	No	`16:9`, `9:16`, `1:1`, `4:3`, `3:4` o `21:9`. Valor predeterminado: `16:9`.
`generate_audio`	boolean	No	Genera el audio del video. Valor predeterminado: `true`.
`reference_image_urls`	array	No	Hasta nueve URL HTTPS públicas de imágenes.
`reference_video_urls`	array	No	Hasta tres URL HTTPS públicas de videos.
`operation`	string	No	`generate` o `edit`. La edición requiere al menos un video de referencia. Valor predeterminado: `generate`.
`seed`	integer	No	Semilla opcional para una generación reproducible.

Ejemplo de solicitud

curl https://orkas.ai/v1/videos \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt":"Camera circles a ceramic lamp in a dark studio",
    "duration":5,
    "resolution":"720p",
    "quality":"balanced",
    "ratio":"16:9",
    "generate_audio":true
  }'

Consultar el estado del video

Endpoint

GET

https://orkas.ai/v1/videos/{id}

Consultar el estado del video

Autenticación

Authorization: Bearer $ORKAS_API_KEY

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	ID de tarea devuelto por la solicitud de creación.

Ejemplo de solicitud

curl https://orkas.ai/v1/videos/$TASK_ID \
  -H "Authorization: Bearer $ORKAS_API_KEY"

Consumo de créditos

Concepto de facturación	Créditos descontados	Unidad de facturación
`balanced` · De texto o imagen a video · 480p	37	Por segundo de salida
`balanced` · De texto o imagen a video · 720p	80	Por segundo de salida
`balanced` · De texto o imagen a video · 1080p	248	Por segundo de salida
`quality` · De texto o imagen a video · 480p	46	Por segundo de salida
`quality` · De texto o imagen a video · 720p	100	Por segundo de salida
`quality` · De texto o imagen a video · 1080p	248	Por segundo de salida
`balanced` / `quality` · Edición de video o generación a partir de un video de referencia · 480p	51	Por segundo de salida
`balanced` / `quality` · Edición de video o generación a partir de un video de referencia · 720p	109	Por segundo de salida
`balanced` / `quality` · Edición de video o generación a partir de un video de referencia · 1080p	271	Por segundo de salida
Consultar el estado del video	0	Por solicitud

Seguridad y límites

Mantén las claves de API en privado, usa claves separadas para distintas aplicaciones y elimina una clave de inmediato si sospechas que se ha filtrado.

Envía la clave en el encabezado de solicitud Authorization: Bearer sk-orkas-….
Para agrupar el consumo de créditos de una conversación, envía el mismo ID opaco en X-Orkas-Conversation-Id en sus solicitudes. Usa solo letras, dígitos, - o _ (hasta 64 caracteres); no envíes un título ni el contenido de los mensajes.
No incluyas una clave en el código de aplicaciones móviles o de navegador, en URL, registros ni sistemas de control de versiones.
Crea una clave separada para cada aplicación para poder reemplazarla sin afectar a otros servicios.
Límites por clave: 120 solicitudes/min para chat y búsqueda, 60 para voz, 30 solicitudes de imágenes y 10 solicitudes de video. Las consultas de estado permiten 120 solicitudes/min.
Si las solicitudes son demasiado frecuentes, la API devuelve HTTP 429. Espera un momento antes de volver a intentarlo.

Historial de créditos

El consumo de la API se identifica por separado en el historial de créditos de Orkas Web, para que puedas distinguirlo del consumo en Orkas.