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.
Chat y Responses proporcionan respuestas del modelo y llamadas a funciones personalizadas que tu aplicación debe procesar; los endpoints de imágenes y video generan contenido multimedia. Estas llamadas a la API no inician una tarea de Commander en la aplicación de escritorio ni involucran automáticamente a sus agentes. Cualquier coordinación adicional de agentes depende del flujo de trabajo de tu aplicación.
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.
Pega la clave en el campo de clave de API de la aplicación.
model
orkas-llm-1.5Recomendado
Ideal para preguntas y respuestas cotidianas, redacción y trabajo de oficina. Incluye DeepSeek V4.1 Flash · GPT-6 Luna · Claude Sonnet 5 · Gemini-3.8 Flash.
orkas-llm-1.5-pro
Ideal para investigación, video, I+D y otras tareas complejas. Incluye GPT-6 Sol · Claude Opus 5.5 · Kimi K3.
Responses Recomendado
Endpoint
POST
https://orkas.ai/v1/responses
Responses
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.
input
string / array
Sí
Texto o elementos de conversación.
reasoning
object
No
Esfuerzo de razonamiento opcional: low, medium o high.
tools
array
No
Definiciones de funciones de herramientas ejecutadas por tu aplicación.
stream
boolean
No
Devuelve una respuesta en streaming cuando el valor es true. Valor predeterminado: false.
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
1k / 1.5k / 2k o un valor de ancho×alto compatible. Valor predeterminado: 1.5k.
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":"1.5k",
"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.
13–23 créditos / imagen de salida + 5 / imagen de entrada
13–23 créditos / imagen de salida + 5 / imagen de entrada (≤2.61 MP: 13; >2.61 MP: 23)
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.
balanced / quality · Edición de video o generación a partir de un video de referencia · 480p
2800
1M tokens Video de referencia: tokens facturados de entrada/salida y consumo mínimo; las imágenes de referencia no tienen cargo adicional
balanced / quality · Edición de video o generación a partir de un video de referencia · 720p
2800
1M tokens Video de referencia: tokens facturados de entrada/salida y consumo mínimo; las imágenes de referencia no tienen cargo adicional
balanced / quality · Edición de video o generación a partir de un video de referencia · 1080p
3100
1M tokens Video de referencia: tokens facturados de entrada/salida y consumo mínimo; las imágenes de referencia no tienen cargo adicional
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.