ข้ามไปที่เนื้อหา
FreshApp Demo

API แบบเปิด

สร้างผลงานจากโค้ดของคุณเอง

ใช้โมเดลของเว็บไซต์จากเซิร์ฟเวอร์ของคุณเอง สร้างงานด้วยคีย์ API ติดตามจนงานเสร็จ แล้วดาวน์โหลดไฟล์ของงานนั้น

API ใช้เฉพาะเครดิตแบบชำระเงิน แพ็กเครดิตแบบชำระเงินหรือการสมัครสมาชิกแบบชำระเงินที่ยังใช้งานอยู่จะเปิดให้ใช้ได้ เก็บคีย์ไว้บนเซิร์ฟเวอร์ของคุณเท่านั้น

ตัวอย่างคำขอ

สร้างงานแรกของคุณ

export API_ORIGIN='https://demo.freshapp.ai'
export API_KEY='sk_YOUR_API_KEY'

curl --fail-with-body "$API_ORIGIN/api/v1/generations" \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1001' \
  -d '{"model":"seed-audio-1.0","input":{"prompt":"ประภาคารบนหน้าผายามรุ่งอรุณ ทะเลสงบ แสงนุ่มนวล"}}'

# Read it every 5 to 10 seconds until its status ends.
curl --fail-with-body "$API_ORIGIN/api/v1/generations/GENERATION_ID" \
  -H "Authorization: Bearer $API_KEY"

# A delivered output's url is a signed link: no key needed.
curl --fail-with-body -o result "OUTPUT_URL"

ตั้งค่า API_KEY เป็นคีย์ของคุณก่อน ส่ง Idempotency-Key ใหม่ทุกครั้งที่ส่งคำขอใหม่ และใช้คีย์เดิมเมื่อส่งคำขอเดิมซ้ำ

วิธีการทำงาน

สามขั้นตอนจากคำขอถึงไฟล์

  1. สร้างงาน

    ส่งรหัสโมเดลและอินพุตพร้อมคีย์ API และ Idempotency-Key คำตอบคืองานนั้นที่อยู่ในคิว พร้อมเครดิตที่กันไว้

  2. ติดตามงาน

    อ่านสถานะงานทุก 5 ถึง 10 วินาทีจนกว่างานจะสำเร็จ สำเร็จบางส่วน ล้มเหลว หรือถูกยกเลิก เครดิตที่ไม่ได้ใช้จะคืนเมื่อชำระยอด

  3. ดาวน์โหลดไฟล์

    เอาต์พุตที่ส่งมอบแล้วแต่ละรายการลิงก์ไปยังไฟล์บนเว็บไซต์นี้ ลิงก์ที่คีย์ได้รับมีลายเซ็นและเปิดได้หนึ่งชั่วโมงโดยไม่ต้องใช้คีย์

สิทธิ์และขีดจำกัด

คีย์ที่ทำได้เฉพาะสิ่งที่คุณอนุญาต

  • คีย์จะอ่านได้อย่างเดียว (ดูรายการ อ่าน และดาวน์โหลด) หรือสร้างได้ด้วย (สร้างและยกเลิก) และใช้รายการ IP ที่อนุญาตผูกคีย์ไว้กับเซิร์ฟเวอร์ของคุณได้

  • คำขอหนึ่งครั้งกันเครดิตได้สูงสุด 150 เครดิต ซึ่งเป็นราคาคำขอที่แพงที่สุดของโมเดลที่เปิดใช้งาน การตั้งค่าของคีย์หรือ max_credits ในคำขอทำได้เพียงลดค่านี้

  • คีย์หนึ่งใช้ได้สูงสุด 5,000 เครดิตต่อวัน UTC และทุกคีย์ของบัญชีรวมกันได้สูงสุด 10,000 เครดิต เว้นแต่คุณจะตั้งขีดจำกัดอื่นในหน้าคีย์ API

  • ต่อคีย์และต่อบัญชี: สร้างและยกเลิกได้ 20 ครั้ง อ่านและดาวน์โหลดได้ 240 ครั้งต่อนาที และมีงานที่ทำงานพร้อมกันได้สูงสุด 2 งาน

ไฟล์

ไฟล์ OpenAPI และไคลเอนต์ TypeScript

ไฟล์ OpenAPI 3.1 ระบุทุกการทำงาน อินพุตของโมเดลที่เปิดใช้งานแต่ละตัว และรหัสข้อผิดพลาดทั้งหมด ไคลเอนต์ TypeScript ไม่ต้องใช้แพ็กเกจอื่น ใช้ Idempotency-Key เดิมตลอดการลองใหม่ และติดตามงานจนจบ ส่วน React hook ใช้ไคลเอนต์นี้เพื่อตรวจสถานะ

คำถามที่พบบ่อย

คำถามเกี่ยวกับ API