API Orkas

Documentation de l’API Orkas

Intégrez les fonctions de chat, de recherche, de synthèse vocale, d’image et de vidéo d’Orkas à vos outils. Commencez par Chat pour trouver l’URL de base, la clé API et les noms de modèles utilisés par la plupart des applications d’IA.

Créer une clé API

Chat

Utilisez le format Chat Completions compatible avec OpenAI dans des applications d’IA, des outils en ligne de commande ou votre propre service.

Paramètres de connexion

Si une application demande une URL de base, une clé API et un modèle, saisissez les valeurs suivantes.

Paramètre	Valeur	Description
`Base URL`	`https://orkas.ai/v1`	Utilisez cette adresse pour le service compatible avec OpenAI.
`API Key`	Créer une clé dans Compte	Collez la clé dans le champ de clé API de l’application.
`model`	`orkas-llm-1.5`Recommandé	Idéal pour les questions-réponses, la rédaction et le travail bureautique au quotidien. Inclut DeepSeek V4 · GPT-5.6 Luna · Claude-Sonnet-5 · Gemini-3.6 Flash.
`model`	`orkas-llm-1.5-pro`	Idéal pour la recherche, la vidéo, la R&D et les autres tâches complexes. Inclut GPT-5.6 Sol · Claude Opus 5 · Kimi K3.

Créer une complétion de chat

Point de terminaison

POST

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

Créer une complétion de chat

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
`model`	string	Oui	`orkas-llm-1.5` ou `orkas-llm-1.5-pro`.
`messages`	array	Oui	Messages de la conversation. Chaque élément contient `role` et `content`.
`stream`	boolean	Non	Renvoie une réponse en flux lorsque la valeur est `true`. Valeur par défaut : `false`.

Exemple de requête

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

Consommation de crédits

Poste de facturation	Crédits débités	Unité de facturation
`orkas-llm-1.5`	Entrée 20–280 ; lecture du cache 2–28 ; création du cache 25–350 ; sortie 120–1260	Par 1M de tokens ; le tarif exact dépend de la requête.
`orkas-llm-1.5-pro`	Entrée 140–1000 ; lecture du cache 14–100 ; création du cache 175–1250 ; sortie 840–4500	Par 1M de tokens ; le tarif exact dépend de la requête.

Recherche

Effectuez une recherche sur le web et obtenez une liste concise de résultats pertinents pour votre application.

Rechercher sur le web

Point de terminaison

POST

https://orkas.ai/v1/search

Rechercher sur le web

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
`query`	string	Oui	Texte de recherche, jusqu’à 2000 caractères.
`max_results`	integer	Non	Nombre de résultats, 1–20. Valeur par défaut : `8`.

Exemple de requête

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

Consommation de crédits

Poste de facturation	Crédits débités	Unité de facturation
Rechercher sur le web	5.6	Par requête, pour un maximum de 20 résultats.

Synthèse vocale

Transformez un texte en fichier audio. Choisissez un identifiant de voix dans la liste ci-dessous et sélectionnez le format audio souhaité.

Lister les voix

Point de terminaison

GET

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

Lister les voix

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres de requête

Ce point de terminaison n’a aucun paramètre de requête.

Exemple de requête

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

Identifiants de voix disponibles

Identifiant de voix	Nom	Langue
`zh_female_vv_uranus_bigtts`	vivi 2.0	Chinois / anglais
`saturn_zh_female_cancan_tob`	知性灿灿	Chinois
`saturn_zh_female_keainvsheng_tob`	可爱女生	Chinois
`saturn_zh_female_tiaopigongzhu_tob`	调皮公主	Chinois
`saturn_zh_male_shuanglangshaonian_tob`	爽朗少年	Chinois
`saturn_zh_male_tiancaitongzhuo_tob`	天才同桌	Chinois
`zh_female_xiaohe_uranus_bigtts`	小何	Chinois
`zh_male_m191_uranus_bigtts`	云舟	Chinois
`zh_male_taocheng_uranus_bigtts`	小天	Chinois
`en_male_tim_uranus_bigtts`	Tim	Anglais
`en_female_dacey_uranus_bigtts`	Dacey	Anglais
`en_female_stokie_uranus_bigtts`	Stokie	Anglais

Générer la parole

Point de terminaison

POST

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

Générer la parole

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
`model`	string	Oui	Utilisez `orkas-tts-1`.
`input`	string	Oui	Texte à synthétiser, jusqu’à 16384 octets UTF-8.
`voice`	string	Oui	Identifiant de voix issu de la liste ci-dessus.
`language`	string	Non	Langue de narration, par exemple `zh-CN` ou `en`. Elle doit être prise en charge par la voix sélectionnée ; sinon, la langue par défaut de la voix est utilisée.
`response_format`	string	Non	`mp3`, `wav`, `opus`, ou `ogg`. Valeur par défaut : `mp3`.
`speed`	number	Non	Vitesse de parole de 0.5 à 2.0. Valeur par défaut : `1.0`.

Exemple de requête

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

Consommation de crédits

Poste de facturation	Crédits débités	Unité de facturation
Lister les voix	0	Par requête
Générer la parole	0.125	Par seconde de sortie estimée, arrondie à l’entier supérieur avec un minimum d’une seconde.

Images

Générez une image à partir d’une description ou fournissez des images de référence à modifier. Une image est renvoyée par requête.

Générer une image

Point de terminaison

POST

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

Générer une image

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
`prompt`	string	Oui	Description de l’image, jusqu’à 20000 caractères.
`size`	string	Non	`2k`, `3k`, `4k`, ou une valeur largeur×hauteur prise en charge. Valeur par défaut : `2k`.
`response_format`	string	Non	`url` ou `b64_json`. Valeur par défaut : `b64_json`.
`reference_images`	array	Non	Jusqu’à quatre URL HTTPS ou URL de données d’image prises en charge pour la modification.
`async`	boolean	Non	Renvoie un identifiant de tâche lorsque la valeur est `true`. Recommandé pour éviter les délais d’expiration des requêtes. Valeur par défaut : `false`.

Exemple de requête

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

Pour les requêtes plus longues : définissez "async": true. L’API renvoie un identifiant de tâche id ; utilisez l’URL d’état jusqu’à ce que le résultat soit prêt.

Vérifier l’état de la génération

Point de terminaison

GET

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

Vérifier l’état de la génération

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`id`	string	Oui	Identifiant de tâche renvoyé par la requête de création.

Exemple de requête

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

Consommation de crédits

Poste de facturation	Crédits débités	Unité de facturation
Générer une image	22	Par image générée
Vérifier l’état de la génération	0	Par requête

Vidéos

Créez une vidéo à partir d’un texte ou de médias de référence. Les requêtes vidéo s’exécutent de manière asynchrone : utilisez l’identifiant de tâche renvoyé pour suivre leur progression.

Créer une vidéo

Point de terminaison

POST

https://orkas.ai/v1/videos

Créer une vidéo

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
`prompt`	string	Oui	Description de la vidéo à générer ou à modifier.
`duration`	integer	Non	4–15 secondes. Valeur par défaut : `5`.
`resolution`	string	Non	`480p`, `720p`, ou `1080p`. Valeur par défaut : `720p`.
`quality`	string	Non	`balanced` équilibre la vitesse et la consommation de crédits ; `quality` privilégie la qualité et la stabilité de la génération. Valeur par défaut : `balanced`. Orkas sélectionne toujours automatiquement le modèle vidéo compatible.
`ratio`	string	Non	`16:9`, `9:16`, `1:1`, `4:3`, `3:4`, ou `21:9`. Valeur par défaut : `16:9`.
`generate_audio`	boolean	Non	Générer le son de la vidéo. Valeur par défaut : `true`.
`reference_image_urls`	array	Non	Jusqu’à neuf URL HTTPS publiques d’images.
`reference_video_urls`	array	Non	Jusqu’à trois URL HTTPS publiques de vidéos.
`operation`	string	Non	`generate` ou `edit`. La modification nécessite au moins une vidéo de référence. Valeur par défaut : `generate`.
`seed`	integer	Non	Graine facultative pour une génération reproductible.

Exemple de requête

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

Vérifier l’état de la vidéo

Point de terminaison

GET

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

Vérifier l’état de la vidéo

Authentification

Authorization: Bearer $ORKAS_API_KEY

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`id`	string	Oui	Identifiant de tâche renvoyé par la requête de création.

Exemple de requête

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

Consommation de crédits

Poste de facturation	Crédits débités	Unité de facturation
`balanced` · Texte ou image vers vidéo · 480p	37	Par seconde de sortie
`balanced` · Texte ou image vers vidéo · 720p	80	Par seconde de sortie
`balanced` · Texte ou image vers vidéo · 1080p	248	Par seconde de sortie
`quality` · Texte ou image vers vidéo · 480p	46	Par seconde de sortie
`quality` · Texte ou image vers vidéo · 720p	100	Par seconde de sortie
`quality` · Texte ou image vers vidéo · 1080p	248	Par seconde de sortie
`balanced` / `quality` · Montage vidéo ou génération à partir d’une vidéo de référence · 480p	51	Par seconde de sortie
`balanced` / `quality` · Montage vidéo ou génération à partir d’une vidéo de référence · 720p	109	Par seconde de sortie
`balanced` / `quality` · Montage vidéo ou génération à partir d’une vidéo de référence · 1080p	271	Par seconde de sortie
Vérifier l’état de la vidéo	0	Par requête

Sécurité et limites

Gardez vos clés API confidentielles, utilisez des clés distinctes pour chaque application et supprimez immédiatement toute clé susceptible d’avoir été divulguée.

Envoyez la clé dans l’en-tête de requête Authorization: Bearer sk-orkas-….
Pour regrouper la consommation de crédits d’une conversation, envoyez le même identifiant opaque dans X-Orkas-Conversation-Id pour ses requêtes. Utilisez uniquement des lettres, des chiffres, -, ou _ (jusqu’à 64 caractères) ; n’envoyez ni titre ni contenu de message.
Ne placez pas de clé dans le code d’un navigateur ou d’une application mobile, dans les URL, les journaux ou le contrôle de versions.
Créez une clé distincte pour chaque application afin de pouvoir la remplacer sans affecter les autres services.
Limites par clé : 120 requêtes/min pour le chat et la recherche, 60 pour la synthèse vocale, 30 requêtes d’image et 10 requêtes vidéo. Les vérifications d’état autorisent 120 requêtes/min.
Si les requêtes sont trop fréquentes, l’API renvoie HTTP 429. Patientez un instant avant de réessayer.

Historique des crédits

L’utilisation de l’API est indiquée séparément dans l’historique des crédits d’Orkas Web, pour vous permettre de la distinguer de l’utilisation dans Orkas.