Floyo API - Introduction
You can use the Floyo API to programmatically run workflows and manage your assets without having to use ComfyUI interface.
The Floyo API is organized around REST. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
All API requests are served over HTTPS to ensure data encryption and security. Unencrypted HTTP requests will be rejected.
The base URL for all API endpoints is https://api.floyo.ai
Authentication
The Floyo API uses API Keys to authenticate requests. You can manage your API Keys in your Team's Settings > Floyo API.
Protect your credentials.
Your API keys carry significant privileges. To prevent unauthorized access, never share your secret keys in publicly accessible areas such as GitHub, client-side code, or mobile applications.
The Bearer Token
All API requests must be made over HTTPS. To authenticate, you must include a Bearer token in the Authorization header of every request.
Example Header:
Authorization: Bearer YOUR_API_KEY
Rate Limits
We limit the number of REST API requests that you can make within a specific amount of time. This limit helps prevent abuse and denial-of-service attacks and ensures that the API remains available for all users.
Requests are rate limited to 100 requests per minute, per API key. If you exceed this limit, the API will return a 429 Too Many Requests response. Wait for the next minute window to resume making requests.
Errors
Floyo API uses conventional HTTP response codes to indicate the success or failure of an API request.
Codes in the 2xx range indicate success.
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, api key was missing or invalid, etc.).
Codes in the 5xx range indicate an error with Floyo's servers (these are rare).
Failed responses include an `error` and `message` attributes.
error is the short error message, i.e. 'Run not found'.
message is an optional error message including an explanation of the error.