Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Gửi tác vụ tạo hình ảnh

Felo API Support
MIT
Máy chủ:https://openapi.felo.ai
Thư viện client
Shell Curl

Gửi tác vụ tạo hình ảnh

​

Trả về HTTP 202 kèm task_id được lưu trữ lâu dài. Gọi GET /api/v1/images/generations/{task_id} định kỳ. Hỗ trợ đầu vào dạng phẳng hoặc lồng nhau; đầu vào lồng nhau được ưu tiên. Các trường callback bị bỏ qua. Khả năng và tham số đầu vào phụ thuộc vào mô hình và kênh đã cấu hình.

Header
  • X-Request-Id
    Kiểu: string

    ID yêu cầu tùy chọn của bên gọi, được trả về để chẩn đoán.

  • X-Felo-Channel
    Kiểu: string

    Mã kênh công khai được phân tách bằng dấu phẩy, có thứ tự. Bỏ trống header này để dùng default; default phải được dùng một mình. Ở chế độ ví, default quét thứ tự kênh công khai hiệu dụng của mô hình theo chiều ngược, bỏ qua các kênh chưa xuất bản hoặc không khả dụng, và chọn nhà cung cấp của kênh khả dụng đầu tiên. Nó bao gồm các endpoint khả dụng của nhà cung cấp đó có cùng ID mô hình upstream và cùng hạng dịch vụ. Các kênh chỉ định rõ được kiểm tra theo thứ tự do client chỉ định; chỉ nhóm nhà cung cấp của kênh đầu tiên được gửi đi. Không tự động dự phòng sang nhà cung cấp khác. Header nhà cung cấp kiểu cũ không thể ghi đè định tuyến kênh.

Phần thân·ImageGenerationRequest
bắt buộc
application/json

Đầu vào theo từng mô hình tuân theo giao thức mô hình công khai đã cấu hình.

  • model
    Kiểu: string
    bắt buộc
  • image_urls
    Kiểu: array string[]
  • input
    Kiểu: object

    Đầu vào lồng nhau tùy chọn; được ưu tiên hơn đầu vào dạng phẳng.

    • service_tier
      Kiểu: string | null

      Hiện chỉ hỗ trợ default (tiêu chuẩn). Giá trị bị bỏ trống, null, các bí danh và chuỗi không được hỗ trợ đều quay về default; các loại khác trả về HTTP 400. Các kênh và giá đã cấu hình không thay đổi. API văn bản gửi giá trị tiêu chuẩn của nhà cung cấp; API Decisions và tạo nội dung bỏ qua trường upstream.

    • propertyName
      Kiểu: anything
  • n
    Kiểu: integer

    Integer numbers.

  • prompt
    Kiểu: string
  • service_tier
    Kiểu: string | null

    Hiện chỉ hỗ trợ default (tiêu chuẩn). Giá trị bị bỏ trống, null, các bí danh và chuỗi không được hỗ trợ đều quay về default; các loại khác trả về HTTP 400. Các kênh và giá đã cấu hình không thay đổi. API văn bản gửi giá trị tiêu chuẩn của nhà cung cấp; API Decisions và tạo nội dung bỏ qua trường upstream.

  • size
    Kiểu: string
  • propertyName
    Kiểu: anything
Phản hồi
  • 202
    Kiểu: object · ImageGenerationAccepted

    Đã tiếp nhận tác vụ

    • kind
      enum
      const:  
      image
      bắt buộc
      giá trị
      • image
    • outputs
      Kiểu: array string[]
      bắt buộc

      Rỗng cho tới khi tác vụ thành công.

    • status
      enum
      const:  
      queued
      bắt buộc
      giá trị
      • queued
    • task_id
      Kiểu: string
      bắt buộc

      ID tác vụ dùng để thăm dò trạng thái.

    application/json
  • 400
    Kiểu: object · GenerationError

    Yêu cầu không hợp lệ (mô hình không xác định, trộn lẫn chế độ nhập, trường không hợp lệ)

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 401
    Kiểu: object · GenerationError

    Khóa API Felo không hợp lệ hoặc bị thiếu

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 402
    Kiểu: object · GenerationError

    Số dư không đủ / chưa đáp ứng yêu cầu thanh toán

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 403
    Kiểu: object · GenerationError

    Tài khoản không được phép (cần đăng ký gói hoặc người dùng bị cấm). Các mô hình đã bị vô hiệu hóa cũng bị từ chối trước khi gọi upstream. Các yêu cầu và tác vụ đã được tiếp nhận vẫn tiếp tục.

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 429
    Kiểu: object · GenerationError

    Đã đạt giới hạn yêu cầu hoặc chi tiêu

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 502
    Kiểu: object · GenerationError

    Nhà cung cấp upstream gặp lỗi

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể null
    application/json
  • 503
    Kiểu: object · GenerationError

    Dịch vụ tạo nội dung hoặc dịch vụ thanh toán tạm thời không khả dụng

    Phong bì lỗi tương thích OpenAI.

    • error
      Kiểu: object
      • message
        Kiểu: string
        bắt buộc
      • type
        Kiểu: string enum
        bắt buộc
        giá trị
        • invalid_request_error
        • server_error
      • code
        Kiểu: string
      • param
        Kiểu: string có thể 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"
  ]
}

Đã tiếp nhận tác vụ

Submit an image generation task