You're on your way to using Scenario's API to build awesome stuff.
To start using the Scenario API, you first need to authenticate your requests. The API employs Basic authentication. All your requests must include the Authorization header set to Basic <credentials>, where credentials is the Base64 encoding of your API key and API secret joined by a single colon :.
To create your API key please follow this guide.
Example:
If your API key is hello and your API secret is world, then you must compute the Base64 encoding for hello:world, which is aGVsbG86d29ybGQ=. Thus, all your requests must include the following header:
Authorization: Basic aGVsbG86d29ybGQ=Comprehensive documentation for all available endpoints is provided here. This resource includes detailed descriptions of each endpoint, parameters, and expected responses.
To help you get started quickly, we have prepared several example recipes, which can be found here. These examples cover common use cases such as creating and training your first model, running your first inference, and more.
For a complete and interactive overview of the API, you can access the OpenAPI specification here. This specification allows you to explore the API's capabilities and understand how to integrate it into your applications.
Details on the API pricing plans can be found here. This page outlines the different pricing tiers and what is included in each, helping you choose the plan that best suits your needs.
If you're new to the Scenario API, check out our Getting Started articles. These guides provide step-by-step instructions to help you begin using the API efficiently.
Understanding the terminology used in the API documentation can help you navigate and utilize the API more effectively. Here are some key terms:
Model: To create a model, you must upload training images and specify parameters. Our cloud platform will handle the training process.
Inference: An inference is a request to generate images from a model. You can specify parameters and generate multiple images in a single request.
Image: An image is one of the results generated from an inference request, similar to the output in the web app.
We encourage you to share your feedback, ask for help, or request features. Your input is invaluable in helping us improve the API and better serve your needs.
For more information, including recipes to create and train your first model, run your first inference, and explore all the possibilities, visit our API Documentation.
Was this helpful?
