Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ส่งงานสร้างรูปภาพ

เซิร์ฟเวอร์:https://openapi.felo.ai
ไลบรารีไคลเอนต์

ส่งงานสร้างรูปภาพ

​

คืน HTTP 202 พร้อม task_id ที่คงอยู่ ให้ตรวจสอบ GET /api/v1/images/generations/{task_id} ซ้ำ รองรับอินพุตแบบแบนหรือแบบซ้อน โดยอินพุตแบบซ้อนมีผลเหนือกว่า ฟิลด์ callback จะถูกละเว้น ความสามารถและพารามิเตอร์อินพุตขึ้นอยู่กับโมเดลและช่องทางที่กำหนดค่าไว้

เฮดเดอร์
  • X-Request-Id
    ประเภท: string

    ID คำขอจากผู้เรียกซึ่งไม่บังคับ ระบบจะสะท้อนกลับมาเพื่อการวินิจฉัย

  • X-Felo-Channel
    ประเภท: string

    รหัสช่องทางสาธารณะที่คั่นด้วยเครื่องหมายจุลภาคตามลำดับ หากไม่ส่งเฮดเดอร์นี้จะใช้ default โดยต้องใช้ default เดี่ยว ๆ เท่านั้น ในโหมดกระเป๋าเงิน default จะสแกนลำดับช่องทางสาธารณะที่มีผลของโมเดลจากท้ายไปต้น ข้ามช่องทางที่ยังไม่เผยแพร่หรือไม่พร้อมใช้งาน และเลือกผู้ให้บริการของช่องทางแรกที่พร้อมใช้งาน โดยจะรวม endpoint ที่พร้อมใช้งานของผู้ให้บริการรายนั้นที่มี upstream model ID และระดับบริการเดียวกัน ช่องทางที่ระบุอย่างชัดเจนจะถูกตรวจสอบตามลำดับที่ไคลเอนต์กำหนด และส่งเฉพาะกลุ่มผู้ให้บริการของช่องทางแรกเท่านั้น ไม่มีการสลับไปยังผู้ให้บริการรายอื่นโดยอัตโนมัติ เฮดเดอร์ผู้ให้บริการแบบเดิมไม่สามารถแทนที่การกำหนดเส้นทางตามช่องทางได้

บอดี้·ImageGenerationRequest
จำเป็น
application/json

อินพุตเฉพาะโมเดลจะเป็นไปตามโปรโตคอลโมเดลสาธารณะที่กำหนดค่าไว้

  • model
    ประเภท: string
    จำเป็น
  • image_urls
    ประเภท: array string[]
  • input
    ประเภท: object

    อินพุตแบบซ้อนซึ่งไม่บังคับ มีผลเหนืออินพุตแบบแบน

    • service_tier
      ประเภท: string | null

      ขณะนี้รองรับเฉพาะ default (standard) เท่านั้น ค่าที่ไม่ระบุ ค่า null ชื่อแทน และสตริงที่ไม่รองรับจะถูกแทนด้วย default ส่วนประเภทอื่นจะคืน HTTP 400 ช่องทางและราคาที่กำหนดค่าไว้ยังคงเดิม API ข้อความจะส่งค่ามาตรฐานของผู้ให้บริการ ส่วน Decisions และ API การสร้างผลงานจะไม่ส่งฟิลด์ต้นทางนี้

    • propertyName
      ประเภท: anything
  • n
    ประเภท: integer

    Integer numbers.

  • prompt
    ประเภท: string
  • service_tier
    ประเภท: string | null

    ขณะนี้รองรับเฉพาะ default (standard) เท่านั้น ค่าที่ไม่ระบุ ค่า null ชื่อแทน และสตริงที่ไม่รองรับจะถูกแทนด้วย default ส่วนประเภทอื่นจะคืน HTTP 400 ช่องทางและราคาที่กำหนดค่าไว้ยังคงเดิม API ข้อความจะส่งค่ามาตรฐานของผู้ให้บริการ ส่วน Decisions และ API การสร้างผลงานจะไม่ส่งฟิลด์ต้นทางนี้

  • size
    ประเภท: string
  • propertyName
    ประเภท: anything
การตอบกลับ
  • 202
    ประเภท: object · ImageGenerationAccepted

    รับงานแล้ว

    • kind
      enum
      const:  
      image
      จำเป็น
      ค่า
      • image
    • outputs
      ประเภท: array string[]
      จำเป็น

      ว่างจนกว่างานจะสำเร็จ

    • status
      enum
      const:  
      queued
      จำเป็น
      ค่า
      • queued
    • task_id
      ประเภท: string
      จำเป็น

      ID ของงานที่ใช้สำหรับตรวจสอบสถานะ

    application/json
  • 400
    ประเภท: object · GenerationError

    คำขอไม่ถูกต้อง (ไม่รู้จักโมเดล โหมดอินพุตปนกัน หรือฟิลด์ไม่ถูกต้อง)

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 401
    ประเภท: object · GenerationError

    คีย์ API ของ Felo ไม่ถูกต้องหรือไม่มี

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 402
    ประเภท: object · GenerationError

    ยอดคงเหลือไม่เพียงพอ / ไม่ตรงตามเงื่อนไขการเรียกเก็บเงิน

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 403
    ประเภท: object · GenerationError

    บัญชีไม่ได้รับอนุญาต (ต้องสมัครสมาชิกหรือผู้ใช้ถูกระงับ) โมเดลที่ปิดใช้งานจะถูกปฏิเสธก่อนเรียกต้นทางเช่นกัน คำขอและงานที่รับไว้แล้วยังคงดำเนินการต่อ

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 429
    ประเภท: object · GenerationError

    ถึงขีดจำกัดคำขอหรือการใช้จ่ายแล้ว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 502
    ประเภท: object · GenerationError

    ผู้ให้บริการต้นทางล้มเหลว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
  • 503
    ประเภท: object · GenerationError

    บริการสร้างผลงานหรือบริการเรียกเก็บเงินไม่พร้อมใช้งานชั่วคราว

    ซองข้อผิดพลาดที่เข้ากันได้กับ OpenAI

    • error
      ประเภท: object
      • message
        ประเภท: string
        จำเป็น
      • type
        ประเภท: string enum
        จำเป็น
        ค่า
        • invalid_request_error
        • server_error
      • code
        ประเภท: string
      • param
        ประเภท: string เป็น null ได้
    application/json
Request Example for post/api/v1/images/generations
curl https://openapi.felo.ai/api/v1/images/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-image-model",
  "prompt": "a cat"
}'
{
  "task_id": "string",
  "status": "queued",
  "kind": "image",
  "outputs": [
    "string"
  ]
}
Submit an image generation task