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 переглядає ефективний порядок публічних каналів моделі у зворотному напрямку, пропускає неопубліковані або недоступні канали та обирає постачальника першого доступного каналу. Він охоплює доступні ендпоінти цього постачальника з тим самим ID моделі в апстрімі та рівнем обслуговування. Явно вказані канали перевіряються в порядку, заданому клієнтом; надсилається лише група постачальника першого каналу. Автоматичного переходу до інших постачальників немає. Застарілі заголовки постачальника не можуть перевизначити маршрутизацію каналів.

Тіло·ImageGenerationRequest

обов'язкове

application/json

Вхідні дані для конкретної моделі відповідають налаштованому публічному протоколу моделі.

model
Тип: string
обов'язкове
image_urls
Тип: array string[]
input
Тип: object

Необов'язкові вкладені вхідні дані; мають пріоритет над пласкими.
- service_tier
  Тип: string | null
  
  Наразі підтримується лише default (standard). Пропущене значення, null, псевдоніми та непідтримувані рядки замінюються на default; інші типи повертають HTTP 400. Налаштовані канали й ціни залишаються без змін. Текстові API надсилають стандартне значення постачальника; API Decisions і генерації пропускають поле апстріму.
- propertyName
  Тип: anything
n
Тип: integer

Integer numbers.
prompt
Тип: string
service_tier
Тип: string | null

Наразі підтримується лише default (standard). Пропущене значення, 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
обов'язкове

ID завдання для опитування статусу.
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

Надіслати завдання на генерацію зображення