Scenario

Hi, how can we help you today?

Getting Started & Authentication

Objective

In this article, you will learn how to obtain your API credentials, authenticate requests using Basic Auth, and understand the critical Asynchronous Workflow used by the Scenario API. This is the foundation for all subsequent guides.

Prerequisites

  • A Scenario account (Pro, Team, or Enterprise).

Step 1: Obtain Your API Key

  1. Log in to the Scenario Web App.

  2. Navigate to Project Settings (via your Project Dropdown).

  3. Click on the API Keys tab.

  4. Click Add API Key.

  5. Secure Your Key

Once created, you'll see your API key and secret. This is the only time your secret will be fully displayed, so it's crucial to save it securely:

  • Download the credentials as a CSV file using the download button

  • Store this information in a secure password manager or secret management system

  • Click 'I've secured my secret key' only after you've safely stored your credentials

Your API key is now ready to use in your applications. For security, we recommend create separate API keys for different projects or environments rather than reusing the same key everywhere.

Step 2: Understanding Basic Authentication

Scenario uses Basic Authentication. This is not a simple Bearer token. You must construct an authorization header by combining your Key and Secret.

The Formula:

  1. Combine credentials: API_KEY:API_SECRET

  2. Encode the resulting string in Base64.

  3. Prepend Authorization: Basic <Base64String>

For example, if your API key is hello and your secret is world, you would:

  1. Combine them with a colon: hello:world

  2. Encode this string in Base64: aGVsbG86d29ybGQ=

  3. Include the header: Authorization: Basic aGVsbG86d29ybGQ=

Step 3: The Asynchronous Workflow (Trigger -> Job -> Asset)

Most generative AI tasks (like creating images or training models) take time (from seconds to minutes). To prevent timeouts, the Scenario API is Asynchronous.

  1. Trigger: You send a POST request to start a task (e.g., Generate Image).

  • Response: The API immediately returns a jobId.

  1. Poll: You repeatedly GET the /jobs/{jobId} endpoint.

  • Response: Returns the status (queued, processing, success, failure).

  1. Retrieve: Once the status is success, the response includes assetIds (your final images/models).

Documentation & Resources

For a complete list of endpoints, parameters, and SDKs, please visit our full developer documentation:

Was this helpful?