APIs 📡

This section introduces Sola’s APIs and explains how to interact with the Sola platform programmatically, including authentication and request basics.

Introduction

Sola’s APIs allow you to programmatically run workflows and integrate Sola into your existing systems. Workflows are callable via API and can also call external APIs, enabling flexible and composable automation across platforms.

With Sola’s APIs, you can do things like:

Run workflows
Check workflow execution status
Retrieve workflow results
Integrate Sola workflows with internal tools and external platforms

Authentication

All API calls to Sola are authenticated using API keys.

Each user can generate up to 5 keys at a time directly from your dashboard. To do so, follow the steps below:

Go to your dashboard.
Click on the API Keys tab.
Click on Create API Key and give the key a name. Set scopes if the feature is enabled on your account.
Click on Create API Key.

<aside> 🚨 Once created, the platform will not show the API Key value anymore, so you MUST store this properly.

</aside>

You will need to send the API Key in the Authorization header when calling our APIs (passing it with “Bearer”).

API Setup

<aside> ⚠️

See our API webpage for details on generating API calls

For Postman users, you can download and import a boilerplate collection, which provides examples of each API call:

Sola Collection

</aside>

From the API Call setup, you can generate sample API requests to test your workflow.

Once you’ve set up your API key, the page will provide a Sample API request you can use locally to call the workflow.

Note that if your workflow takes input variables from API requests, you will need to pass the variable values within your API call. By adding values in the Test API trigger with variable values section, a sample API request will be generated with variableData correctly formatted in the data section of the request. You can then update this section to change the value of the variables you would like to pass in.

https://app.arcade.software/share/AW39uJJni8jRDMSVNHuR

Browser Context

Contexts are an advanced feature that control how browser states are persisted and reused across workflow executions. For most use cases, advanced contexts are not necessary. If your workflows swap between many accounts, at high volumes, then context can help improve overall runtimes. To learn more, visit the Context page below.

Browser Context in Workflows

If you have any further questions or need assistance, please explore the rest of the documentation, and don't hesitate to reach out to our team via the shared Slack channel or by contacting [email protected]. We are here to help you!