v0.4.0

OpenAPI 3.1.0

إرسال مهمة توليد صورة

Felo API Support

MIT

الخادم

https://openapi.felo.ai

مكتبات العملاء

Shell Curl

إرسال مهمة توليد صورة

يعيد HTTP 202 مع task_id دائم. استعلم عبر GET /api/v1/images/generations/{task_id}. الإدخال المسطّح أو المتداخل مدعوم؛ ويُرجَّح الإدخال المتداخل. تُتجاهل حقول callback. تعتمد القدرات ومعاملات الإدخال على النموذج والقناة المُهيَّأين.

الرؤوس

X-Request-Id
النوع: string

معرّف طلب اختياري من المستدعي يُعاد في الاستجابة لأغراض التشخيص.
X-Felo-Channel
النوع: string

رموز قنوات عامة مرتبة ومفصولة بفواصل. احذف هذه الترويسة لاستخدام default؛ ويجب استخدام default وحده. في وضع المحفظة، يفحص default ترتيب القنوات العامة الفعلية للنموذج بترتيب عكسي، ويتخطى القنوات غير المنشورة أو غير المتاحة، ويختار مزوّد أول قناة متاحة. ويشمل نقاط النهاية المتاحة من ذلك المزوّد ذات معرّف النموذج الأعلى ومستوى الخدمة نفسيهما. تُتحقق القنوات الصريحة بالترتيب الذي يحدده العميل؛ ولا تُقدَّم سوى مجموعة مزوّد القناة الأولى. لا يوجد رجوع تلقائي إلى مزوّدين آخرين. لا يمكن لترويسات المزوّد القديمة تجاوز توجيه القنوات.

الجسم·ImageGenerationRequest

مطلوب

application/json

يتبع الإدخال الخاص بكل نموذج بروتوكول النموذج العام المُهيَّأ.

model
النوع: string
مطلوب
image_urls
النوع: array string[]
input
النوع: object

إدخال متداخل اختياري؛ يُرجَّح على الإدخال المسطّح.
- service_tier
  النوع: string | null
  
  لا يُدعم حاليًا سوى default (standard). عند الحذف أو null أو الأسماء البديلة أو السلاسل غير المدعومة، يحدث رجوع إلى default؛ وتعيد الأنواع الأخرى HTTP 400. تبقى القنوات والأسعار المُهيَّأة دون تغيير. ترسل واجهات API النصية القيمة القياسية للمزوّد؛ وتحذف واجهات Decisions والتوليد حقل المنبع.
- propertyName
  النوع: anything
n
النوع: integer

Integer numbers.
prompt
النوع: string
service_tier
النوع: string | null

لا يُدعم حاليًا سوى default (standard). عند الحذف أو null أو الأسماء البديلة أو السلاسل غير المدعومة، يحدث رجوع إلى default؛ وتعيد الأنواع الأخرى HTTP 400. تبقى القنوات والأسعار المُهيَّأة دون تغيير. ترسل واجهات API النصية القيمة القياسية للمزوّد؛ وتحذف واجهات Decisions والتوليد حقل المنبع.
size
النوع: string
propertyName
النوع: anything

الاستجابات

202
النوع: object · ImageGenerationAccepted

تم قبول المهمة
kind
تعداد
ثابت:
image
مطلوب
القيم
image
outputs
النوع: array string[]
مطلوب

فارغ حتى تنجح المهمة.

status
تعداد
ثابت:
queued
مطلوب
القيم
queued
task_id
النوع: string
مطلوب

معرّف المهمة لاستخدامه في الاستعلام.
application/json
400
النوع: object · GenerationError

طلب غير صالح (نموذج غير معروف، أنماط إدخال مختلطة، حقول غير صالحة)

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
401
النوع: object · GenerationError

مفتاح API من Felo غير صالح أو مفقود

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
402
النوع: object · GenerationError

الرصيد غير كافٍ / متطلب الفوترة غير مستوفٍ

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
403
النوع: object · GenerationError

الحساب غير مصرّح له (يلزم اشتراك أو المستخدم محظور). تُرفض النماذج المعطّلة قبل استدعاءات المنبع أيضًا. تظل الطلبات والمهام المقبولة قائمة.

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
429
النوع: object · GenerationError

تم بلوغ حد الطلبات أو حد الإنفاق

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
502
النوع: object · GenerationError

فشل مزوّد المنبع

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json
503
النوع: object · GenerationError

خدمة التوليد أو خدمة الفوترة غير متاحة مؤقتًا

مغلّف أخطاء متوافق مع OpenAI.
error
النوع: object
message
النوع: string
مطلوب
type
النوع: string تعداد
مطلوب
القيم
invalid_request_error
server_error
code
النوع: string
param
النوع: string يقبل null
application/json

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"
  ]
}

تم قبول المهمة

إرسال مهمة توليد صورة

المصادقةRequired

إرسال مهمة توليد صورة