Orkas-API-Dokumentation
Binden Sie die Chat-, Such-, Sprach-, Bild- und Videofunktionen von Orkas in Ihre eigenen Tools ein. Beginnen Sie mit Chat: Dort finden Sie die Basis-URL, den API-Schlüssel und die Modellnamen, die die meisten KI-Anwendungen verwenden.
Chat
Verwenden Sie das OpenAI-kompatible Chat-Completions-Format in KI-Anwendungen, Befehlszeilentools oder Ihrem eigenen Dienst.
Verbindungseinstellungen
Wenn eine Anwendung nach Basis-URL, API-Schlüssel und Modell fragt, geben Sie die folgenden Werte ein.
| Einstellung | Wert | Beschreibung |
|---|---|---|
Base URL | https://orkas.ai/v1 | Verwenden Sie dies als Adresse des OpenAI-kompatiblen Dienstes. |
API Key | Schlüssel unter „Konto“ erstellen | Fügen Sie den Schlüssel in das API-Schlüsselfeld der Anwendung ein. |
model | orkas-llm-1.5Empfohlen | Ideal für alltägliche Fragen und Antworten, Schreiben und Büroarbeit. Enthält DeepSeek V4 · GPT-5.6 Luna · Claude-Sonnet-5 · Gemini-3.6 Flash. |
orkas-llm-1.5-pro | Ideal für Recherche, Video, Forschung und Entwicklung sowie andere komplexe Aufgaben. Enthält GPT-5.6 Sol · Claude Opus 5 · Kimi K3. |
Chat-Vervollständigung erstellen
Endpunkt
https://orkas.ai/v1/chat/completionsAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYParameter im Anfragetext
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
model | string | Ja | orkas-llm-1.5 oder orkas-llm-1.5-pro. |
messages | array | Ja | Nachrichten der Konversation. Jeder Eintrag enthält role und content. |
stream | boolean | Nein | Bei true wird eine Streaming-Antwort zurückgegeben. Standard: false. |
Anfragebeispiel
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"}]
}'Credit-Verbrauch
| Abrechnungsposten | Credit-Abzug | Abrechnungseinheit |
|---|---|---|
orkas-llm-1.5 | Eingabe 20–280; Cache lesen 2–28; Cache erstellen 25–350; Ausgabe 120–1260 | Pro 1M Tokens; der genaue Satz hängt von der Anfrage ab. |
orkas-llm-1.5-pro | Eingabe 140–1000; Cache lesen 14–100; Cache erstellen 175–1250; Ausgabe 840–4500 | Pro 1M Tokens; der genaue Satz hängt von der Anfrage ab. |
Suche
Durchsuchen Sie das Web und erhalten Sie eine kompakte Liste relevanter Ergebnisse für Ihre Anwendung.
Web durchsuchen
Endpunkt
https://orkas.ai/v1/searchAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYParameter im Anfragetext
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
query | string | Ja | Suchtext, bis zu 2000 Zeichen. |
max_results | integer | Nein | Anzahl der Ergebnisse, 1–20. Standard: 8. |
Anfragebeispiel
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}'Credit-Verbrauch
| Abrechnungsposten | Credit-Abzug | Abrechnungseinheit |
|---|---|---|
| Web durchsuchen | 5.6 | Pro Anfrage, für bis zu 20 Ergebnisse. |
Sprache
Wandeln Sie Text in eine Audiodatei um. Wählen Sie eine Stimmen-ID aus der folgenden Liste und das benötigte Audioformat.
Stimmen auflisten
Endpunkt
https://orkas.ai/v1/audio/voicesAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYAnfrageparameter
Dieser Endpunkt hat keine Anfrageparameter.
Anfragebeispiel
curl https://orkas.ai/v1/audio/voices \
-H "Authorization: Bearer $ORKAS_API_KEY"Verfügbare Stimmen-IDs
| Stimmen-ID | Name | Sprache |
|---|---|---|
zh_female_vv_uranus_bigtts | vivi 2.0 | Chinesisch / Englisch |
saturn_zh_female_cancan_tob | 知性灿灿 | Chinesisch |
saturn_zh_female_keainvsheng_tob | 可爱女生 | Chinesisch |
saturn_zh_female_tiaopigongzhu_tob | 调皮公主 | Chinesisch |
saturn_zh_male_shuanglangshaonian_tob | 爽朗少年 | Chinesisch |
saturn_zh_male_tiancaitongzhuo_tob | 天才同桌 | Chinesisch |
zh_female_xiaohe_uranus_bigtts | 小何 | Chinesisch |
zh_male_m191_uranus_bigtts | 云舟 | Chinesisch |
zh_male_taocheng_uranus_bigtts | 小天 | Chinesisch |
en_male_tim_uranus_bigtts | Tim | Englisch |
en_female_dacey_uranus_bigtts | Dacey | Englisch |
en_female_stokie_uranus_bigtts | Stokie | Englisch |
Sprache generieren
Endpunkt
https://orkas.ai/v1/audio/speechAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYParameter im Anfragetext
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
model | string | Ja | Verwenden Sie orkas-tts-1. |
input | string | Ja | Zu synthetisierender Text, bis zu 16384 UTF-8-Bytes. |
voice | string | Ja | Stimmen-ID aus der obigen Liste. |
language | string | Nein | Sprache der Vertonung, etwa zh-CN oder en. Sie muss von der ausgewählten Stimme unterstützt werden; andernfalls wird deren Standardsprache verwendet. |
response_format | string | Nein | mp3, wav, opus oder ogg. Standard: mp3. |
speed | number | Nein | Sprechgeschwindigkeit von 0.5 bis 2.0. Standard: 1.0. |
Anfragebeispiel
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.mp3Credit-Verbrauch
| Abrechnungsposten | Credit-Abzug | Abrechnungseinheit |
|---|---|---|
| Stimmen auflisten | 0 | Pro Anfrage |
| Sprache generieren | 0.125 | Pro geschätzter Ausgabesekunde, auf mindestens eine Sekunde aufgerundet. |
Bilder
Generieren Sie ein Bild anhand einer Beschreibung oder stellen Sie Referenzbilder zur Bearbeitung bereit. Pro Anfrage wird ein Bild zurückgegeben.
Bild generieren
Endpunkt
https://orkas.ai/v1/images/generationsAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYParameter im Anfragetext
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
prompt | string | Ja | Bildbeschreibung, bis zu 20000 Zeichen. |
size | string | Nein | 2k, 3k, 4k oder ein unterstützter Wert für Breite×Höhe. Standard: 2k. |
response_format | string | Nein | url oder b64_json. Standard: b64_json. |
reference_images | array | Nein | Bis zu vier HTTPS-URLs oder unterstützte Bild-Daten-URLs zur Bearbeitung. |
async | boolean | Nein | Bei true wird eine Aufgaben-ID zurückgegeben. Empfohlen, um Zeitüberschreitungen bei Anfragen zu vermeiden. Standard: false. |
Anfragebeispiel
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
}'"async": true. Die API gibt eine Aufgaben-id zurück; verwenden Sie die Status-URL, bis das Ergebnis bereitsteht.Generierungsstatus prüfen
Endpunkt
https://orkas.ai/v1/images/generations/{id}Authentifizierung
Authorization: Bearer $ORKAS_API_KEYPfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | Ja | Aufgaben-ID, die von der Erstellungsanfrage zurückgegeben wird. |
Anfragebeispiel
curl https://orkas.ai/v1/images/generations/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"Credit-Verbrauch
| Abrechnungsposten | Credit-Abzug | Abrechnungseinheit |
|---|---|---|
| Bild generieren | 22 | Pro generiertem Bild |
| Generierungsstatus prüfen | 0 | Pro Anfrage |
Videos
Erstellen Sie ein Video aus Text oder Referenzmedien. Videoanfragen laufen asynchron; prüfen Sie den Fortschritt mit der zurückgegebenen Aufgaben-ID.
Video erstellen
Endpunkt
https://orkas.ai/v1/videosAuthentifizierung
Authorization: Bearer $ORKAS_API_KEYParameter im Anfragetext
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
prompt | string | Ja | Beschreibung des zu generierenden oder zu bearbeitenden Videos. |
duration | integer | Nein | 4–15 Sekunden. Standard: 5. |
resolution | string | Nein | 480p, 720p oder 1080p. Standard: 720p. |
quality | string | Nein | balanced wägt Geschwindigkeit und Credit-Verbrauch ab; quality priorisiert Generierungsqualität und Stabilität. Standard: balanced. Orkas wählt weiterhin automatisch das kompatible Videomodell aus. |
ratio | string | Nein | 16:9, 9:16, 1:1, 4:3, 3:4 oder 21:9. Standard: 16:9. |
generate_audio | boolean | Nein | Videoton generieren. Standard: true. |
reference_image_urls | array | Nein | Bis zu neun öffentliche HTTPS-Bild-URLs. |
reference_video_urls | array | Nein | Bis zu drei öffentliche HTTPS-Video-URLs. |
operation | string | Nein | generate oder edit. Für die Bearbeitung ist mindestens ein Referenzvideo erforderlich. Standard: generate. |
seed | integer | Nein | Optionaler Seed für reproduzierbare Generierung. |
Anfragebeispiel
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
}'Videostatus prüfen
Endpunkt
https://orkas.ai/v1/videos/{id}Authentifizierung
Authorization: Bearer $ORKAS_API_KEYPfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | Ja | Aufgaben-ID, die von der Erstellungsanfrage zurückgegeben wird. |
Anfragebeispiel
curl https://orkas.ai/v1/videos/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"Credit-Verbrauch
| Abrechnungsposten | Credit-Abzug | Abrechnungseinheit |
|---|---|---|
balanced · Text oder Bild zu Video · 480p | 37 | Pro Ausgabesekunde |
balanced · Text oder Bild zu Video · 720p | 80 | Pro Ausgabesekunde |
balanced · Text oder Bild zu Video · 1080p | 248 | Pro Ausgabesekunde |
quality · Text oder Bild zu Video · 480p | 46 | Pro Ausgabesekunde |
quality · Text oder Bild zu Video · 720p | 100 | Pro Ausgabesekunde |
quality · Text oder Bild zu Video · 1080p | 248 | Pro Ausgabesekunde |
balanced / quality · Videobearbeitung oder Generierung mit Referenzvideo · 480p | 51 | Pro Ausgabesekunde |
balanced / quality · Videobearbeitung oder Generierung mit Referenzvideo · 720p | 109 | Pro Ausgabesekunde |
balanced / quality · Videobearbeitung oder Generierung mit Referenzvideo · 1080p | 271 | Pro Ausgabesekunde |
| Videostatus prüfen | 0 | Pro Anfrage |
Sicherheit und Limits
Halten Sie API-Schlüssel geheim, verwenden Sie für verschiedene Anwendungen separate Schlüssel und löschen Sie einen Schlüssel sofort, wenn er möglicherweise offengelegt wurde.
- Senden Sie den Schlüssel im Anfrageheader
Authorization: Bearer sk-orkas-…. - Um den Credit-Verbrauch einer Konversation zu gruppieren, senden Sie bei deren Anfragen dieselbe opake ID in
X-Orkas-Conversation-Id. Verwenden Sie nur Buchstaben, Ziffern,-oder_(bis zu 64 Zeichen); senden Sie weder einen Titel noch Nachrichteninhalte. - Speichern Sie Schlüssel weder im Code von Browser- oder Mobilanwendungen noch in URLs, Protokollen oder der Versionsverwaltung.
- Erstellen Sie für jede Anwendung einen separaten Schlüssel, damit er sich ohne Auswirkungen auf andere Dienste ersetzen lässt.
- Limits pro Schlüssel: 120 Anfragen/min für Chat und Suche, 60 für Sprache, 30 Bildanfragen und 10 Videoanfragen. Für Statusabfragen sind 120 Anfragen/min zulässig.
- Bei zu häufigen Anfragen gibt die API HTTP 429 zurück. Warten Sie kurz, bevor Sie es erneut versuchen.
Credit-Verlauf
API-Nutzung wird im Credit-Verlauf von Orkas Web separat gekennzeichnet, damit Sie sie von der Nutzung in Orkas unterscheiden können.