Orkas API ドキュメント
Orkas のチャット、検索、音声、画像、動画をお使いのツールに接続できます。多くの AI アプリでは、チャット欄の Base URL、API キー、モデル名だけで設定できます。
チャット
OpenAI 互換の Chat Completions 形式で、AI アプリ、コマンドラインツール、独自サービスから利用できます。
接続設定
アプリで Base URL、API キー、モデルを求められた場合は、次の値を入力してください。
| 設定項目 | 値 | 説明 |
|---|---|---|
Base URL | https://orkas.ai/v1 | OpenAI 互換サービスのアドレスとして使用します。 |
API Key | アカウントでキーを作成 | 作成したキーをアプリの API キー欄に貼り付けます。 |
model | orkas-llm-1.5おすすめ | 日常的な Q&A、文章作成、オフィス業務に適しています。含まれるモデル:DeepSeek V4 · GPT-5.6 Luna · Claude-Sonnet-5 · Gemini-3.6 Flash。 |
orkas-llm-1.5-pro | 調査、動画、研究開発などの複雑なタスクに適しています。含まれるモデル:GPT-5.6 Sol · Claude Opus 5 · Kimi K3。 |
チャット応答を作成
エンドポイント
POSTチャット応答を作成
https://orkas.ai/v1/chat/completions認証
Authorization: Bearer $ORKAS_API_KEYリクエスト本文のパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
model | string | はい | orkas-llm-1.5 または orkas-llm-1.5-pro。 |
messages | array | はい | 会話メッセージ。各項目に role と content を含めます。 |
stream | boolean | いいえ | true の場合はストリーミング応答。既定値は false。 |
リクエスト例
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"}]
}'クレジット消費
| 課金項目 | 差し引きクレジット | 課金単位 |
|---|---|---|
orkas-llm-1.5 | 入力 20–280、キャッシュ読み取り 2–28、キャッシュ作成 25–350、出力 120–1,260 | 100 万 token あたり。正確な単価はリクエストにより変わります。 |
orkas-llm-1.5-pro | 入力 140–1,000、キャッシュ読み取り 14–100、キャッシュ作成 175–1,250、出力 840–4,500 | 100 万 token あたり。正確な単価はリクエストにより変わります。 |
検索
Web を検索し、アプリで使いやすい関連結果の一覧を返します。
Web を検索
エンドポイント
POSTWeb を検索
https://orkas.ai/v1/search認証
Authorization: Bearer $ORKAS_API_KEYリクエスト本文のパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
query | string | はい | 検索文字列。最大 2,000 文字。 |
max_results | integer | いいえ | 結果件数は 1~20。既定値は 8。 |
リクエスト例
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}'クレジット消費
| 課金項目 | 差し引きクレジット | 課金単位 |
|---|---|---|
| Web を検索 | 5.6 | リクエストごと、最大 20 件。 |
音声
テキストを音声ファイルに変換します。下の一覧から音声 ID と必要な形式を選んでください。
音声一覧
エンドポイント
GET音声一覧
https://orkas.ai/v1/audio/voices認証
Authorization: Bearer $ORKAS_API_KEYリクエストパラメータ
このエンドポイントにリクエストパラメータはありません。
リクエスト例
curl https://orkas.ai/v1/audio/voices \
-H "Authorization: Bearer $ORKAS_API_KEY"利用できる音声 ID
| 音声 ID | 名前 | 言語 |
|---|---|---|
zh_female_vv_uranus_bigtts | vivi 2.0 | 中国語 / 英語 |
saturn_zh_female_cancan_tob | 知性灿灿 | 中国語 |
saturn_zh_female_keainvsheng_tob | 可爱女生 | 中国語 |
saturn_zh_female_tiaopigongzhu_tob | 调皮公主 | 中国語 |
saturn_zh_male_shuanglangshaonian_tob | 爽朗少年 | 中国語 |
saturn_zh_male_tiancaitongzhuo_tob | 天才同桌 | 中国語 |
zh_female_xiaohe_uranus_bigtts | 小何 | 中国語 |
zh_male_m191_uranus_bigtts | 云舟 | 中国語 |
zh_male_taocheng_uranus_bigtts | 小天 | 中国語 |
en_male_tim_uranus_bigtts | Tim | 英語 |
en_female_dacey_uranus_bigtts | Dacey | 英語 |
en_female_stokie_uranus_bigtts | Stokie | 英語 |
音声を生成
エンドポイント
POST音声を生成
https://orkas.ai/v1/audio/speech認証
Authorization: Bearer $ORKAS_API_KEYリクエスト本文のパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
model | string | はい | orkas-tts-1 を使用します。 |
input | string | はい | 合成するテキスト。最大 16,384 UTF-8 バイト。 |
voice | string | はい | 上の一覧にある音声 ID。 |
language | string | いいえ | zh-CN や en などの読み上げ言語。選んだ音声が対応している必要があります。省略時は音声の既定言語です。 |
response_format | string | いいえ | mp3、wav、opus、ogg。既定値は mp3。 |
speed | number | いいえ | 速度は 0.5~2.0。既定値は 1.0。 |
リクエスト例
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クレジット消費
| 課金項目 | 差し引きクレジット | 課金単位 |
|---|---|---|
| 音声一覧 | 0 | リクエストごと |
| 音声を生成 | 0.125 | 推定出力 1 秒ごと。最低 1 秒として切り上げます。 |
画像
説明から画像を生成したり、参照画像を使って編集したりできます。1 回のリクエストで 1 枚返します。
画像を生成
エンドポイント
POST画像を生成
https://orkas.ai/v1/images/generations認証
Authorization: Bearer $ORKAS_API_KEYリクエスト本文のパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
prompt | string | はい | 画像の説明。最大 20,000 文字。 |
size | string | いいえ | 2k、3k、4k、または対応する幅×高さ。既定値は 2k。 |
response_format | string | いいえ | url または b64_json。既定値は b64_json。 |
reference_images | array | いいえ | 編集用の HTTPS URL または対応する画像 data URL。最大 4 個。 |
async | boolean | いいえ | true の場合はタスク ID を返します。タイムアウト回避のため推奨します。既定値は false。 |
リクエスト例
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 を指定します。返されたタスク id を状態 URL で確認してください。生成状態を確認
エンドポイント
GET生成状態を確認
https://orkas.ai/v1/images/generations/{id}認証
Authorization: Bearer $ORKAS_API_KEYパスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 作成リクエストで返されたタスク ID。 |
リクエスト例
curl https://orkas.ai/v1/images/generations/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"クレジット消費
| 課金項目 | 差し引きクレジット | 課金単位 |
|---|---|---|
| 画像を生成 | 22 | 生成画像 1 枚ごと |
| 生成状態を確認 | 0 | リクエストごと |
動画
テキストや参照メディアから動画を作成します。非同期処理のため、返されたタスク ID で進行状況を確認します。
動画を生成
エンドポイント
POST動画を生成
https://orkas.ai/v1/videos認証
Authorization: Bearer $ORKAS_API_KEYリクエスト本文のパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
prompt | string | はい | 生成または編集する動画の説明。 |
duration | integer | いいえ | 4~15 秒。既定値は 5。 |
resolution | string | いいえ | 480p、720p、1080p。既定値は 720p。 |
quality | string | いいえ | balanced は速度とクレジット消費のバランスを取り、quality は生成品質と安定性を優先します。既定値は balanced。実際の動画モデルは Orkas が自動選択します。 |
ratio | string | いいえ | 16:9、9:16、1:1、4:3、3:4、21:9。既定値は 16:9。 |
generate_audio | boolean | いいえ | 動画の音声を生成します。既定値は true。 |
reference_image_urls | array | いいえ | 公開 HTTPS 画像 URL。最大 9 個。 |
reference_video_urls | array | いいえ | 公開 HTTPS 動画 URL。最大 3 個。 |
operation | string | いいえ | generate または edit。編集には参照動画が 1 個以上必要です。既定値は generate。 |
seed | integer | いいえ | 再現性を高めるための任意の seed。 |
リクエスト例
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
}'動画の状態を確認
エンドポイント
GET動画の状態を確認
https://orkas.ai/v1/videos/{id}認証
Authorization: Bearer $ORKAS_API_KEYパスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 作成リクエストで返されたタスク ID。 |
リクエスト例
curl https://orkas.ai/v1/videos/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"クレジット消費
| 課金項目 | 差し引きクレジット | 課金単位 |
|---|---|---|
balanced · テキストまたは画像から動画 · 480p | 37 | 出力 1 秒ごと |
balanced · テキストまたは画像から動画 · 720p | 80 | 出力 1 秒ごと |
balanced · テキストまたは画像から動画 · 1080p | 248 | 出力 1 秒ごと |
quality · テキストまたは画像から動画 · 480p | 46 | 出力 1 秒ごと |
quality · テキストまたは画像から動画 · 720p | 100 | 出力 1 秒ごと |
quality · テキストまたは画像から動画 · 1080p | 248 | 出力 1 秒ごと |
balanced / quality · 動画編集または参照動画から生成 · 480p | 51 | 出力 1 秒ごと |
balanced / quality · 動画編集または参照動画から生成 · 720p | 109 | 出力 1 秒ごと |
balanced / quality · 動画編集または参照動画から生成 · 1080p | 271 | 出力 1 秒ごと |
| 動画の状態を確認 | 0 | リクエストごと |
セキュリティと制限
API キーは非公開にし、アプリごとに分け、漏えいの可能性があれば直ちに削除してください。
Authorization: Bearer sk-orkas-…リクエストヘッダーでキーを送信します。- 同じ会話のクレジット使用量をまとめるには、その会話の各リクエストで同じ匿名 ID を
X-Orkas-Conversation-Idヘッダーに指定します。ID は英数字、-、_のみ、最大 64 文字です。会話タイトルやメッセージ内容は送信しないでください。 - ブラウザやモバイルアプリのコード、URL、ログ、ソース管理にキーを置かないでください。
- アプリごとに別のキーを使うと、他のサービスに影響せず交換できます。
- キーごとの上限:チャットと検索は毎分 120、音声 60、画像 30、動画 10。状態確認は毎分 120 です。
- リクエストが多すぎる場合は HTTP 429 が返ります。少し待ってから再試行してください。
クレジット履歴
API の利用は Orkas Web の履歴で区別して表示され、Orkas 内の利用と見分けられます。