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

اختیاری کالر درخواست ID جو تشخیص کے لیے واپس بھیجی جاتی ہے۔
X-Felo-Channel
قسم: string

ترتیب شدہ، کوما سے الگ کیے گئے پبلک چینل کوڈز۔ default استعمال کرنے کے لیے یہ ہیڈر چھوڑ دیں؛ default کو تنہا ہی استعمال کرنا ہوگا۔ wallet موڈ میں default ماڈل کے مؤثر پبلک چینل کی ترتیب کو الٹی سمت میں اسکین کرتا ہے، غیر شائع شدہ یا غیر دستیاب چینلز کو نظر انداز کرتا ہے، اور پہلے دستیاب چینل کے پرووائیڈر کا انتخاب کرتا ہے۔ اس میں اسی اپ اسٹریم ماڈل ID اور سروس ٹیئر والے اس پرووائیڈر کے دستیاب endpoints شامل کیے جاتے ہیں۔ واضح چینلز کی توثیق کلائنٹ کی بتائی ہوئی ترتیب میں ہوتی ہے؛ صرف پہلے چینل کا پرووائیڈر گروپ جمع کیا جاتا ہے۔ دیگر پرووائیڈرز کی طرف کوئی خودکار fallback نہیں ہے۔ پرانے پرووائیڈر ہیڈرز چینل روٹنگ کو اوور رائیڈ نہیں کر سکتے۔

باڈی·ImageGenerationRequest

لازمی

application/json

ماڈل کے لیے مخصوص ان پٹ ترتیب شدہ پبلک ماڈل پروٹوکول کی پیروی کرتا ہے۔

model
قسم: string
لازمی
image_urls
قسم: array string[]
input
قسم: object

اختیاری نیسٹڈ input؛ فلیٹ ان پٹ پر ترجیح پاتا ہے۔
- service_tier
  قسم: string | null
  
  فی الحال صرف default (standard) معاون ہے۔ چھوڑا گیا، null، عرفی نام اور غیر معاون اسٹرنگز default پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔
- propertyName
  قسم: anything
n
قسم: integer

Integer numbers.
prompt
قسم: string
service_tier
قسم: string | null

فی الحال صرف default (standard) معاون ہے۔ چھوڑا گیا، null، عرفی نام اور غیر معاون اسٹرنگز default پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔
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

غلط یا غیر موجود Felo API کلید

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

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

امیج جنریشن ٹاسک جمع کریں