Orkas APIเอกสาร Orkas API
เชื่อมต่อความสามารถด้านแชต การค้นหา เสียงพูด ภาพ และวิดีโอของ Orkas เข้ากับเครื่องมือของคุณเอง เริ่มที่แชตเพื่อดู URL ฐาน คีย์ API และชื่อโมเดลที่แอปพลิเคชัน AI ส่วนใหญ่ใช้
แชต
Chat และ Responses ให้คำตอบจากโมเดลและการเรียกฟังก์ชันที่กำหนดเองซึ่งแอปของคุณต้องจัดการ ส่วนเอนด์พอยต์รูปภาพและวิดีโอใช้สร้างสื่อ การเรียก API เหล่านี้จะไม่เริ่มงาน Commander ในแอปเดสก์ท็อปหรือเรียกใช้เอเจนต์ของแอปโดยอัตโนมัติ การประสานงานเอเจนต์เพิ่มเติมขึ้นอยู่กับเวิร์กโฟลว์ของแอปคุณ
การตั้งค่าการเชื่อมต่อ
หากแอปพลิเคชันขอ URL ฐาน คีย์ API และโมเดล ให้ป้อนค่าต่อไปนี้
| การตั้งค่า | ค่า | คำอธิบาย |
|---|
Base URL | https://orkas.ai/v1
| ใช้ค่านี้เป็นที่อยู่บริการที่เข้ากันได้กับ OpenAI |
API Key | สร้างคีย์ในหน้าบัญชี | วางคีย์ลงในช่องคีย์ API ของแอปพลิเคชัน |
model | orkas-llm-1.5แนะนำ
| เหมาะที่สุดสำหรับการถามตอบทั่วไป งานเขียน และงานสำนักงาน มี DeepSeek V4.1 Flash · GPT-6 Luna · Claude Sonnet 5 · Gemini-3.8 Flash |
orkas-llm-1.5-pro
| เหมาะที่สุดสำหรับงานวิจัย วิดีโอ การวิจัยและพัฒนา และงานซับซ้อนอื่น ๆ มี GPT-6 Sol · Claude Opus 5.5 · Kimi K3 |
Responses แนะนำ
เอนด์พอยต์
POSThttps://orkas.ai/v1/responses
Responses การยืนยันตัวตน
Authorization: Bearer $ORKAS_API_KEY
พารามิเตอร์ในเนื้อหาคำขอ
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|
model | string | ใช่ | orkas-llm-1.5 หรือ orkas-llm-1.5-pro |
input | string / array | ใช่ | ข้อความหรือรายการสนทนา |
reasoning | object | ไม่ | ระดับการให้เหตุผลที่เลือกได้: low, medium หรือ high |
tools | array | ไม่ | คำจำกัดความฟังก์ชันของเครื่องมือที่แอปของคุณเรียกใช้ |
stream | boolean | ไม่ | ส่งคำตอบแบบสตรีมเมื่อเป็น true ค่าเริ่มต้น: false |
ตัวอย่างคำขอ
curl https://orkas.ai/v1/responses \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "orkas-llm-1.5",
"input": "Hello",
"reasoning": {"effort": "medium"}
}'
Chat
เอนด์พอยต์
POSThttps://orkas.ai/v1/chat/completions
Chat การยืนยันตัวตน
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 | อินพุต 50–100; อ่านแคช 5–10; สร้างแคช 62.5–125; เอาต์พุต 250–375 | ต่อ 1 ล้านโทเคนสำหรับโมเดลหลัก |
orkas-llm-1.5-pro | อินพุต 200–400; อ่านแคช 10–20; สร้างแคช 250–500; เอาต์พุต 1,000–1,500 | ต่อ 1 ล้านโทเคนสำหรับโมเดลหลัก |
ค้นหา
ค้นหาเว็บและส่งกลับรายการผลลัพธ์ที่เกี่ยวข้องแบบกระชับสำหรับแอปพลิเคชันของคุณ
ค้นหาเว็บ
เอนด์พอยต์
POSThttps://orkas.ai/v1/search
ค้นหาเว็บ การยืนยันตัวตน
Authorization: Bearer $ORKAS_API_KEY
พารามิเตอร์ในเนื้อหาคำขอ
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|
query | string | ใช่ | ข้อความค้นหา สูงสุด 128 อักขระ |
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}'
การใช้เครดิต
| รายการเรียกเก็บเงิน | เครดิตที่หัก | หน่วยเรียกเก็บเงิน |
|---|
| ค้นหาเว็บ | 0.5 | ต่อคำขอ สำหรับผลลัพธ์สูงสุด 20 รายการ |
เสียงพูด
เปลี่ยนข้อความเป็นไฟล์เสียง เลือก ID เสียงจากรายการด้านล่างและเลือกรูปแบบเสียงที่ต้องการ
แสดงรายการเสียง
เอนด์พอยต์
GEThttps://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 | อังกฤษ |
สร้างเสียงพูด
เอนด์พอยต์
POSThttps://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 | ต่อวินาทีเอาต์พุตโดยประมาณ ปัดขึ้นโดยคิดขั้นต่ำหนึ่งวินาที |
ภาพ
สร้างภาพจากคำอธิบาย หรือให้ภาพอ้างอิงเพื่อแก้ไข โดยจะส่งกลับหนึ่งภาพต่อคำขอ
สร้างภาพ
เอนด์พอยต์
POSThttps://orkas.ai/v1/images/generations
สร้างภาพ การยืนยันตัวตน
Authorization: Bearer $ORKAS_API_KEY
พารามิเตอร์ในเนื้อหาคำขอ
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|
prompt | string | ใช่ | คำอธิบายภาพ สูงสุด 20,000 อักขระ |
size | string | ไม่ | 1k / 1.5k / 2k หรือค่าความกว้าง×ความสูงที่รองรับ ค่าเริ่มต้น: 1.5k |
response_format | string | ไม่ | url หรือ b64_json ค่าเริ่มต้น: b64_json |
reference_images | array | ไม่ | URL แบบ HTTPS หรือ URL ข้อมูลภาพที่รองรับ สูงสุดสี่รายการสำหรับการแก้ไข |
async | boolean | ไม่ | ส่งกลับ ID งานเมื่อเป็น true แนะนำเพื่อหลีกเลี่ยงคำขอหมดเวลา ค่าเริ่มต้น: 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":"1.5k",
"response_format":"url",
"async":true
}'
สำหรับคำขอที่ใช้เวลานาน: ตั้งค่า "async": true API จะส่งกลับ id งาน ให้ใช้ URL สถานะจนกว่าผลลัพธ์จะพร้อม
ตรวจสอบสถานะการสร้าง
เอนด์พอยต์
GEThttps://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"
การใช้เครดิต
| รายการเรียกเก็บเงิน | เครดิตที่หัก | หน่วยเรียกเก็บเงิน |
|---|
| สร้างภาพ | 13–23 เครดิต / ภาพผลลัพธ์ + 5 / ภาพนำเข้า | 13–23 เครดิต / ภาพผลลัพธ์ + 5 / ภาพนำเข้า (≤2.61 MP: 13; >2.61 MP: 23) |
| ตรวจสอบสถานะการสร้าง | 0 | ต่อคำขอ |
วิดีโอ
สร้างวิดีโอจากข้อความหรือสื่ออ้างอิง คำขอวิดีโอทำงานแบบอะซิงโครนัส จึงต้องใช้ ID งานที่ส่งกลับเพื่อตรวจสอบความคืบหน้า
สร้างวิดีโอ
เอนด์พอยต์
POSThttps://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 | ไม่ | URL ภาพ HTTPS ที่เข้าถึงได้สาธารณะ สูงสุดเก้ารายการ |
reference_video_urls | array | ไม่ | URL วิดีโอ HTTPS ที่เข้าถึงได้สาธารณะ สูงสุดสามรายการ |
operation | string | ไม่ | generate หรือ edit การแก้ไขต้องมีวิดีโออ้างอิงอย่างน้อยหนึ่งรายการ ค่าเริ่มต้น: 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
}'
ตรวจสอบสถานะวิดีโอ
เอนด์พอยต์
GEThttps://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 | ต่อวินาทีเอาต์พุต |
balanced · ข้อความหรือภาพเป็นวิดีโอ · 720p | 80 | ต่อวินาทีเอาต์พุต |
balanced · ข้อความหรือภาพเป็นวิดีโอ · 1080p | 248 | ต่อวินาทีเอาต์พุต |
quality · ข้อความหรือภาพเป็นวิดีโอ · 480p | 46 | ต่อวินาทีเอาต์พุต |
quality · ข้อความหรือภาพเป็นวิดีโอ · 720p | 100 | ต่อวินาทีเอาต์พุต |
quality · ข้อความหรือภาพเป็นวิดีโอ · 1080p | 248 | ต่อวินาทีเอาต์พุต |
balanced / quality · การแก้ไขวิดีโอหรือการสร้างจากวิดีโออ้างอิง · 480p | 2800 | 1M tokens วิดีโออ้างอิง: คิดตามโทเค็นจริง รวมวิดีโอนำเข้า/ผลลัพธ์และการใช้ขั้นต่ำ ภาพอ้างอิงไม่มีค่าบริการแยก |
balanced / quality · การแก้ไขวิดีโอหรือการสร้างจากวิดีโออ้างอิง · 720p | 2800 | 1M tokens วิดีโออ้างอิง: คิดตามโทเค็นจริง รวมวิดีโอนำเข้า/ผลลัพธ์และการใช้ขั้นต่ำ ภาพอ้างอิงไม่มีค่าบริการแยก |
balanced / quality · การแก้ไขวิดีโอหรือการสร้างจากวิดีโออ้างอิง · 1080p | 3100 | 1M tokens วิดีโออ้างอิง: คิดตามโทเค็นจริง รวมวิดีโอนำเข้า/ผลลัพธ์และการใช้ขั้นต่ำ ภาพอ้างอิงไม่มีค่าบริการแยก |
| ตรวจสอบสถานะวิดีโอ | 0 | ต่อคำขอ |
ความปลอดภัยและข้อจำกัด
เก็บคีย์ API เป็นความลับ ใช้คีย์แยกสำหรับแต่ละแอปพลิเคชัน และลบคีย์ทันทีหากอาจรั่วไหล
- ส่งคีย์ในส่วนหัวคำขอ
Authorization: Bearer sk-orkas-… - หากต้องการจัดกลุ่มการใช้เครดิตจากบทสนทนาเดียวกัน ให้ส่ง ID ที่ไม่สื่อความหมายค่าเดียวกันใน
X-Orkas-Conversation-Id ของคำขอเหล่านั้น ใช้เฉพาะตัวอักษร ตัวเลข - หรือ _ (สูงสุด 64 อักขระ) อย่าส่งชื่อเรื่องหรือเนื้อหาข้อความ - อย่าใส่คีย์ในโค้ดเบราว์เซอร์หรือแอปมือถือ URL บันทึกระบบ หรือระบบควบคุมซอร์สโค้ด
- สร้างคีย์แยกสำหรับแต่ละแอปพลิเคชัน เพื่อเปลี่ยนคีย์ได้โดยไม่กระทบบริการอื่น
- ขีดจำกัดต่อคีย์: 120 คำขอ/นาทีสำหรับแชตและการค้นหา 60 สำหรับเสียงพูด 30 คำขอภาพ และ 10 คำขอวิดีโอ การตรวจสอบสถานะทำได้ 120 คำขอ/นาที
- หากส่งคำขอถี่เกินไป API จะส่งกลับ HTTP 429 โปรดรอสักครู่ก่อนลองอีกครั้ง
ประวัติเครดิต
การใช้ API จะมีเครื่องหมายแยกในประวัติเครดิตบนเว็บ Orkas เพื่อให้คุณแยกจากการใช้งานใน Orkas ได้