API Orkas

Documentação da API Orkas

Ligue a conversa, a pesquisa, a voz, a imagem e o vídeo do Orkas às suas ferramentas. Para a maioria das aplicações de IA, basta usar o URL base, a chave de API e o modelo da secção Conversa.

Criar chave de API

Conversa

Use o formato Chat Completions compatível com OpenAI em aplicações de IA, ferramentas de linha de comandos ou no seu serviço.

Definições de ligação

Se uma aplicação pedir o URL base, a chave de API e o modelo, introduza 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 da aplicação.
`model`	`orkas-llm-1.5`Recomendado	Ideal para perguntas e respostas, redação e tarefas quotidianas de escritório. Inclui DeepSeek V4.1 Flash · GPT-6 Luna · Claude-Sonnet-5 · Gemini-3.8 Flash.
`model`	`orkas-llm-1.5-pro`	Ideal para pesquisa, vídeo, I&D e outras tarefas complexas. Inclui GPT-6 Sol · Claude Opus 5.5 · Kimi K3.

Criar resposta de conversa

Ponto de acesso

POST

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

Criar resposta de conversa

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo do pedido

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	Devolve a resposta de forma contínua quando `true`. Predefinição: `false`.

Exemplo de pedido

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 faturação	Débito de créditos	Unidade de faturação
`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 do pedido.
`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 do pedido.

Pesquisa

Pesquise na Web e obtenha uma lista compacta de resultados relevantes para a sua aplicação.

Pesquisar na Web

Ponto de acesso

POST

https://orkas.ai/v1/search

Pesquisar na Web

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo do pedido

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

Exemplo de pedido

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 faturação	Débito de créditos	Unidade de faturação
Pesquisar na Web	5.6	Por pedido, para até 20 resultados.

Voz

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

Listar vozes

Ponto de acesso

GET

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

Listar vozes

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do pedido

Este ponto de acesso não tem parâmetros de pedido.

Exemplo de pedido

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

Ponto de acesso

POST

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

Gerar voz

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo do pedido

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 suportado pela voz; se for omitido, é usado o idioma predefinido da voz.
`response_format`	string	Não	`mp3`, `wav`, `opus` ou `ogg`. Predefinição: `mp3`.
`speed`	number	Não	Velocidade de 0,5 a 2,0. Predefinição: `1.0`.

Exemplo de pedido

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 faturação	Débito de créditos	Unidade de faturação
Listar vozes	0	Por pedido
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 pedido devolve uma imagem.

Gerar imagem

Ponto de acesso

POST

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

Gerar imagem

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo do pedido

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. Predefinição: `2k`.
`response_format`	string	Não	`url` ou `b64_json`. Predefinição: `b64_json`.
`reference_images`	array	Não	Até quatro URLs HTTPS ou URLs de dados de imagem compatíveis para edição.
`async`	boolean	Não	Devolve um ID de tarefa quando `true`. Recomendado para evitar exceder o tempo limite. Predefinição: `false`.

Exemplo de pedido

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 pedidos demorados: use "async": true. A API devolve um id; consulte o URL de estado até o resultado estar pronto.

Consultar geração

Ponto de acesso

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 devolvido pelo pedido de criação.

Exemplo de pedido

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

Uso de créditos

Item de faturação	Débito de créditos	Unidade de faturação
Gerar imagem	22	Por imagem gerada
Consultar geração	0	Por pedido

Vídeos

Crie um vídeo a partir de texto ou conteúdos multimédia de referência. O processamento é assíncrono; use o ID devolvido para o acompanhar.

Gerar vídeo

Ponto de acesso

POST

https://orkas.ai/v1/videos

Gerar vídeo

Autenticação

Authorization: Bearer $ORKAS_API_KEY

Parâmetros do corpo do pedido

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. Predefinição: `5`.
`resolution`	string	Não	`480p`, `720p` ou `1080p`. Predefinição: `720p`.
`quality`	string	Não	`balanced` equilibra a velocidade e o uso de créditos; `quality` dá prioridade à qualidade e à estabilidade da geração. Predefinição: `balanced`. O Orkas continua a selecionar 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`. Predefinição: `16:9`.
`generate_audio`	boolean	Não	Gera áudio para o vídeo. Predefiniçã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. Predefinição: `generate`.
`seed`	integer	Não	Semente opcional para melhorar a repetibilidade.

Exemplo de pedido

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

Ponto de acesso

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 devolvido pelo pedido de criação.

Exemplo de pedido

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

Uso de créditos

Item de faturação	Débito de créditos	Unidade de faturação
`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 pedido

Segurança e limites

Mantenha as chaves privadas, use uma por aplicação e elimine imediatamente uma chave que possa ter sido exposta.

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 dos pedidos. 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 da aplicação móvel, em URLs, registos ou no controlo de versões.
Use uma chave por aplicação para poder trocá-la sem afetar outros serviços.
Limites por chave: 120 req/min para conversa e pesquisa, 60 para voz, 30 para imagem e 10 para vídeo. A consulta de estado permite 120 req/min.
Pedidos demasiado frequentes devolvem 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, o que facilita a distinção face ao uso dentro do Orkas.