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 (استاندارد) پشتیبانی می‌شود. مقادیر حذف‌شده، null، نام‌های مستعار و رشته‌های پشتیبانی‌نشده به default بازمی‌گردند؛ انواع دیگر HTTP 400 برمی‌گردانند. کانال‌ها و قیمت‌های پیکربندی‌شده بدون تغییر می‌مانند. APIهای متنی مقدار استاندارد ارائه‌دهنده را ارسال می‌کنند؛ APIهای Decisions و تولید فیلد بالادست را حذف می‌کنند.
- propertyName
  نوع: anything
n
نوع: integer

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

در حال حاضر فقط default (استاندارد) پشتیبانی می‌شود. مقادیر حذف‌شده، null، نام‌های مستعار و رشته‌های پشتیبانی‌نشده به default بازمی‌گردند؛ انواع دیگر HTTP 400 برمی‌گردانند. کانال‌ها و قیمت‌های پیکربندی‌شده بدون تغییر می‌مانند. APIهای متنی مقدار استاندارد ارائه‌دهنده را ارسال می‌کنند؛ 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 تهی‌پذیر
application/json
401
نوع: object · GenerationError

کلید API Felo نامعتبر است یا وجود ندارد.

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
application/json
402
نوع: object · GenerationError

موجودی ناکافی / الزام صورت‌حساب برآورده نشده است

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
application/json
403
نوع: object · GenerationError

حساب مجاز نیست (اشتراک لازم است یا کاربر مسدود شده است). مدل‌های غیرفعال نیز پیش از فراخوانی‌های بالادست رد می‌شوند. درخواست‌ها و وظایف پذیرفته‌شده موجود ادامه می‌یابند.

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
application/json
429
نوع: object · GenerationError

سقف درخواست یا هزینه به پایان رسیده است

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
application/json
502
نوع: object · GenerationError

ارائه‌دهنده بالادست ناموفق بود

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
application/json
503
نوع: object · GenerationError

سرویس تولید یا سرویس صورت‌حساب موقتاً در دسترس نیست

پاکت خطای سازگار با OpenAI.
error
نوع: object
message
نوع: string
الزامی
type
نوع: string فهرست مقادیر
الزامی
مقادیر
invalid_request_error
server_error
code
نوع: string
param
نوع: string تهی‌پذیر
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

ارسال وظیفه تولید تصویر