API Orkas

Documentação da API Orkas

Conecte chat, busca, voz, imagem e vídeo do Orkas às suas ferramentas. Para a maioria dos apps de IA, basta usar a Base URL, a chave de API e o modelo da seção Chat.

Criar chave de API

Chat

Use o formato Chat Completions compatível com OpenAI em apps de IA, ferramentas de linha de comando ou no seu serviço.

Configurações de conexão

Se um app pedir Base URL, chave de API e modelo, informe os valores abaixo.

Configuração	Valor	Descrição
`Base URL`	`https://orkas.ai/v1`	Use como endereço do serviço compatível com OpenAI.
`API Key`	Criar chave na Conta	Cole a chave no campo de chave de API do aplicativo.
`model`	`orkas-llm-1.5`Recomendado	Ideal para perguntas e respostas, redação e tarefas cotidianas de escritório. Inclui DeepSeek V4 · GPT-5.6 Luna · Claude-Sonnet-5 · Gemini-3.6 Flash.
`model`	`orkas-llm-1.5-pro`	Ideal para pesquisa, vídeo, P&D e outras tarefas complexas. Inclui GPT-5.6 Sol · Claude Opus 5 · Kimi K3.

Criar resposta de chat

Endpoint

POST

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

Criar resposta de chat

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`model`	string	Sim	`orkas-llm-1.5` ou `orkas-llm-1.5-pro`.
`messages`	array	Sim	Mensagens da conversa. Cada item contém `role` e `content`.
`stream`	boolean	Não	Retorna resposta em streaming quando `true`. Padrão: `false`.

Exemplo de solicitação

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"}]
  }'

Uso de créditos

Item de cobrança	Débito de créditos	Unidade de cobrança
`orkas-llm-1.5`	Entrada 20–280; leitura de cache 2–28; criação de cache 25–350; saída 120–1.260	Por 1 milhão de tokens; a taxa exata depende da solicitação.
`orkas-llm-1.5-pro`	Entrada 140–1.000; leitura de cache 14–100; criação de cache 175–1.250; saída 840–4.500	Por 1 milhão de tokens; a taxa exata depende da solicitação.

Busca

Pesquise na Web e retorne uma lista compacta de resultados relevantes para seu aplicativo.

Buscar na Web

Endpoint

POST

https://orkas.ai/v1/search

Buscar na Web

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`query`	string	Sim	Texto da busca, até 2.000 caracteres.
`max_results`	integer	Não	Quantidade de resultados, 1–20. Padrão: `8`.

Exemplo de solicitação

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}'

Uso de créditos

Item de cobrança	Débito de créditos	Unidade de cobrança
Buscar na Web	5.6	Por solicitação, para até 20 resultados.

Voz

Transforme texto em arquivo de áudio. Escolha um ID de voz abaixo e o formato necessário.

Listar vozes

Endpoint

GET

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

Listar vozes

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros da solicitação

Este endpoint não possui parâmetros de solicitação.

Exemplo de solicitação

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

IDs de voz disponíveis

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

Gerar voz

Endpoint

POST

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

Gerar voz

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`model`	string	Sim	Use `orkas-tts-1`.
`input`	string	Sim	Texto a sintetizar, até 16.384 bytes UTF-8.
`voice`	string	Sim	ID de voz da lista acima.
`language`	string	Não	Idioma da narração, como `zh-CN` ou `en`. Deve ser aceito pela voz; se omitido, usa o idioma padrão da voz.
`response_format`	string	Não	`mp3`, `wav`, `opus` ou `ogg`. Padrão: `mp3`.
`speed`	number	Não	Velocidade de 0,5 a 2,0. Padrão: `1.0`.

Exemplo de solicitação

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

Uso de créditos

Item de cobrança	Débito de créditos	Unidade de cobrança
Listar vozes	0	Por solicitação
Gerar voz	0.125	Por segundo estimado de saída, arredondado para pelo menos um segundo.

Imagens

Gere uma imagem a partir de uma descrição ou use imagens de referência para editar. Cada solicitação retorna uma imagem.

Gerar imagem

Endpoint

POST

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

Gerar imagem

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`prompt`	string	Sim	Descrição da imagem, até 20.000 caracteres.
`size`	string	Não	`2k`, `3k`, `4k` ou largura×altura compatível. Padrão: `2k`.
`response_format`	string	Não	`url` ou `b64_json`. Padrão: `b64_json`.
`reference_images`	array	Não	Até quatro URLs HTTPS ou data URLs de imagem compatíveis para edição.
`async`	boolean	Não	Retorna um ID de tarefa quando `true`. Recomendado para evitar timeout. Padrão: `false`.

Exemplo de solicitação

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 solicitações demoradas: use "async": true. A API retorna um id; consulte a URL de status até o resultado ficar pronto.

Consultar geração

Endpoint

GET

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

Consultar geração

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do caminho

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da tarefa retornado pela solicitação de criação.

Exemplo de solicitação

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

Uso de créditos

Item de cobrança	Débito de créditos	Unidade de cobrança
Gerar imagem	22	Por imagem gerada
Consultar geração	0	Por solicitação

Vídeos

Crie um vídeo a partir de texto ou mídia de referência. O processamento é assíncrono; use o ID retornado para acompanhar.

Gerar vídeo

Endpoint

POST

https://orkas.ai/v1/videos

Gerar vídeo

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`prompt`	string	Sim	Descrição do vídeo a gerar ou editar.
`duration`	integer	Não	4–15 segundos. Padrão: `5`.
`resolution`	string	Não	`480p`, `720p` ou `1080p`. Padrão: `720p`.
`quality`	string	Não	`balanced` equilibra velocidade e uso de créditos; `quality` prioriza qualidade e estabilidade da geração. Padrão: `balanced`. O Orkas continua selecionando automaticamente o modelo de vídeo compatível.
`ratio`	string	Não	`16:9`, `9:16`, `1:1`, `4:3`, `3:4` ou `21:9`. Padrão: `16:9`.
`generate_audio`	boolean	Não	Gera áudio para o vídeo. Padrão: `true`.
`reference_image_urls`	array	Não	Até nove URLs HTTPS públicas de imagem.
`reference_video_urls`	array	Não	Até três URLs HTTPS públicas de vídeo.
`operation`	string	Não	`generate` ou `edit`. A edição exige pelo menos um vídeo de referência. Padrão: `generate`.
`seed`	integer	Não	Seed opcional para melhorar a repetibilidade.

Exemplo de solicitação

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 vídeo

Endpoint

GET

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

Consultar vídeo

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do caminho

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da tarefa retornado pela solicitação de criação.

Exemplo de solicitação

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

Uso de créditos

Item de cobrança	Débito de créditos	Unidade de cobrança
`balanced` · Texto ou imagem para vídeo · 480p	37	Por segundo de saída
`balanced` · Texto ou imagem para vídeo · 720p	80	Por segundo de saída
`balanced` · Texto ou imagem para vídeo · 1080p	248	Por segundo de saída
`quality` · Texto ou imagem para vídeo · 480p	46	Por segundo de saída
`quality` · Texto ou imagem para vídeo · 720p	100	Por segundo de saída
`quality` · Texto ou imagem para vídeo · 1080p	248	Por segundo de saída
`balanced` / `quality` · Edição ou geração com vídeo de referência · 480p	51	Por segundo de saída
`balanced` / `quality` · Edição ou geração com vídeo de referência · 720p	109	Por segundo de saída
`balanced` / `quality` · Edição ou geração com vídeo de referência · 1080p	271	Por segundo de saída
Consultar vídeo	0	Por solicitação

Segurança e limites

Mantenha as chaves privadas, use uma por aplicativo e exclua imediatamente uma chave que possa ter vazado.

Envie a chave no cabeçalho Authorization: Bearer sk-orkas-….
Para agrupar o consumo de créditos de uma conversa, envie o mesmo ID anônimo no cabeçalho X-Orkas-Conversation-Id das solicitações. Use apenas letras, números, - ou _ (até 64 caracteres); não envie o título nem o conteúdo das mensagens.
Não coloque chaves no código do navegador ou app móvel, URLs, logs ou controle de versão.
Use uma chave por aplicativo para poder trocá-la sem afetar outros serviços.
Limites por chave: 120 req/min para chat e busca, 60 para voz, 30 para imagem e 10 para vídeo. O status permite 120 req/min.
Solicitações muito frequentes retornam HTTP 429. Aguarde um pouco antes de tentar novamente.

Histórico de créditos

O uso da API aparece separado no histórico do Orkas Web, facilitando a distinção do uso dentro do Orkas.