Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

इमेज जनरेशन टास्क सबमिट करें

सर्वर:https://openapi.felo.ai
क्लाइंट लाइब्रेरी

इमेज जनरेशन टास्क सबमिट करें

​

HTTP 202 के साथ स्थायी task_id लौटाता है। GET /api/v1/images/generations/{task_id} को पोल करें। फ़्लैट input या नेस्टेड input समर्थित है; नेस्टेड input को प्राथमिकता मिलती है। callback फ़ील्ड अनदेखे किए जाते हैं। क्षमताएँ और input पैरामीटर कॉन्फ़िगर किए गए मॉडल और चैनल पर निर्भर करते हैं।

headers
  • X-Request-Id
    टाइप: string

    वैकल्पिक caller request ID, जो डायग्नोस्टिक्स के लिए वापस भेजी जाती है।

  • X-Felo-Channel
    टाइप: string

    क्रमबद्ध, कॉमा से अलग किए गए सार्वजनिक चैनल कोड। default का उपयोग करने के लिए यह header छोड़ दें; default अकेले ही इस्तेमाल होना चाहिए। वॉलेट मोड में, default मॉडल के प्रभावी सार्वजनिक चैनल क्रम को उल्टे क्रम में स्कैन करता है, अप्रकाशित या अनुपलब्ध चैनल छोड़ देता है, और पहले उपलब्ध चैनल का प्रोवाइडर चुनता है। इसमें उसी upstream मॉडल ID और service tier वाले उस प्रोवाइडर के उपलब्ध endpoints शामिल होते हैं। स्पष्ट रूप से दिए गए चैनल client द्वारा निर्दिष्ट क्रम में सत्यापित होते हैं; केवल पहले चैनल का प्रोवाइडर समूह सबमिट किया जाता है। अन्य प्रोवाइडर पर स्वचालित fallback नहीं होता। पुराने प्रोवाइडर headers चैनल रूटिंग को ओवरराइड नहीं कर सकते।

बॉडी·ImageGenerationRequest
आवश्यक
application/json

मॉडल-विशिष्ट input कॉन्फ़िगर किए गए सार्वजनिक मॉडल प्रोटोकॉल का पालन करता है।

  • model
    टाइप: string
    आवश्यक
  • image_urls
    टाइप: array string[]
  • input
    टाइप: object

    वैकल्पिक नेस्टेड input; फ़्लैट input पर प्राथमिकता लेता है।

    • service_tier
      टाइप: string | null

      फ़िलहाल केवल default (standard) समर्थित है। छोड़ा गया, null, उपनाम और असमर्थित स्ट्रिंग्स default पर fallback करते हैं; अन्य प्रकार HTTP 400 लौटाते हैं। कॉन्फ़िगर किए गए चैनल और कीमतें अपरिवर्तित रहती हैं। Text API प्रोवाइडर का standard मान भेजते हैं; Decisions और जनरेशन API upstream फ़ील्ड छोड़ देते हैं।

    • propertyName
      टाइप: anything
  • n
    टाइप: integer

    Integer numbers.

  • prompt
    टाइप: string
  • service_tier
    टाइप: string | null

    फ़िलहाल केवल default (standard) समर्थित है। छोड़ा गया, null, उपनाम और असमर्थित स्ट्रिंग्स default पर fallback करते हैं; अन्य प्रकार HTTP 400 लौटाते हैं। कॉन्फ़िगर किए गए चैनल और कीमतें अपरिवर्तित रहती हैं। Text API प्रोवाइडर का standard मान भेजते हैं; Decisions और जनरेशन API upstream फ़ील्ड छोड़ देते हैं।

  • size
    टाइप: string
  • propertyName
    टाइप: anything
responses
  • 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

    अमान्य request (अज्ञात मॉडल, मिश्रित input मोड, अमान्य फ़ील्ड)

    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 key

    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

    खाते को अनुमति नहीं है (सदस्यता आवश्यक है या उपयोगकर्ता पर प्रतिबंध है)। बंद किए गए मॉडल भी upstream कॉल से पहले अस्वीकार कर दिए जाते हैं। पहले से स्वीकृत requests और टास्क जारी रहते हैं।

    OpenAI-संगत एरर एनवेलप।

    • error
      टाइप: object
      • message
        टाइप: string
        आवश्यक
      • type
        टाइप: string enum
        आवश्यक
        मान
        • invalid_request_error
        • server_error
      • code
        टाइप: string
      • param
        टाइप: string null स्वीकार्य
    application/json
  • 429
    टाइप: object · GenerationError

    request या खर्च सीमा पूरी हो गई

    OpenAI-संगत एरर एनवेलप।

    • error
      टाइप: object
      • message
        टाइप: string
        आवश्यक
      • type
        टाइप: string enum
        आवश्यक
        मान
        • invalid_request_error
        • server_error
      • code
        टाइप: string
      • param
        टाइप: string null स्वीकार्य
    application/json
  • 502
    टाइप: object · GenerationError

    upstream प्रोवाइडर विफल रहा

    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
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"
  ]
}
Submit an image generation task