Theme switcher

GETTING STARTED

The GETTING STARTED section provides essential information for developers to quickly familiarize themselves with the FastAPI API. Users can learn how to authenticate, make basic API requests, and navigate through the documentation to get started with integrating FastAPI into their projects efficiently.

Was this section helpful?

What made this section unhelpful for you?

Introduction


Welcome to Qolaba, the powerhouse of AI-driven media transformation. Our API, built on REST principles, is your well-marked path through the world of AI models and creative channels. It's a breeze to use, with predictable URLs that are easy to navigate. You send us your request in a format known as JSON, and we return the favor with a JSON response. We operate using standard online protocols, ensuring your requests are handled smoothly and securely.

Qolaba is your trusted ally in the universe of AI-based image, audio, and video creation and modification. We've made the intricate world of public APIs straightforward, transforming your media with ease and efficiency.

Was this section helpful?

What made this section unhelpful for you?

Authentication


To gain access to our API, you'll need to authenticate each request using an API key. You can easily manage and view your API keys on Qolaba API platform.

Keeping your API keys secure is of utmost importance! Avoid sharing your confidential API keys in public spaces, such as GitHub or client-side code.

To authenticate with our API, we use the Bearer Token method. Simply include your API key within the Authorization header like this: -H "Authorization: Bearer **************".

For security reasons, it's essential to make API requests over HTTPS. Any calls made over plain HTTP will not succeed. Also, please be aware that requests lacking proper authentication will be met with failure.

Was this section helpful?

What made this section unhelpful for you?

Pricing


Our API operates on a pay-as-you-go billing model, meaning you're only charged for the resources you consume. Each request for generating an image incurs charges, which are calculated based on the computational resources required to create the image, taking into account factors like output size and processing time.

For the latest pricing information for our models, you can conveniently refer to the API dashboard or utilize the /list_of_deployments endpoint. We've designed these resources to provide you with up-to-date and transparent insights into the cost of using our services, ensuring you have all the information you need to manage your expenses effectively.

Was this section helpful?

What made this section unhelpful for you?

Errors


Our APIs rely on conventional HTTP response codes to convey the outcome of an API request. Response codes falling within the 2xx spectrum signify triumph, indicating that the request has been successfully executed.

Conversely, when response codes fall within the 4xx range, it points to an error stemming from issues with the information furnished—an omission of a mandatory parameter, exceeding rate limits, or supplying an invalid API key, among other potential discrepancies.

Moving further up the numerical scale, response codes residing in the 5xx domain signify complications arising within our server infrastructure, indicating a problem on our end.

Was this section helpful?

What made this section unhelpful for you?

API REFERENCE