API Reference

Authorization

The Stax.ai API uses an API key as an authorization bearer token.

The Stax.ai Developer API can be accessed by sending HTTPS requests to: https://api.stax.ai.
The API has a simple API key authentication scheme.

❗️

Requires Administrator Access

Only administrators of Stax.ai teams have access to the developer API, as it provides access to ALL team stacks and files, as well as external sharing privileges.

Generating an Developer API Key

Pre-requirements:

  • You must be a team administrator.
  • Your team account must be activated. You cannot use the API in trial mode.

In order to get a developer API key, click on your user icon (top-right corner) and go to Manage My Account.

359

In your account management page, scroll down to the bottom to find Developer Keys. Click on Create a new API key.

506

A new API key will be generated. Click on the key field to copy it to clipboard. You can click on the delete/remove icon next to it to remove/deactivate a key.

602

API Request Authentication

All API requests must have a header with your API key to be authenticated. Add the following parameters to your HTTPS request header:

  • Email:
  • Authorization: Bearer

For example, a curl request may look like:

curl -i -H "Email: [email protected]" \
        -H "Authorization: Bearer w3i21te088qskae7p54nt7gm48ajqb2606f5801s" \
        https://api.stax.ai

Javascript/Node.JS Example with Axios

import axios from 'axios';

const res = await axios.get('https://api.stax.ai', {
    headers: {
        Email: '[email protected]',
        Authorization: 'Bearer w3i21te088qskae7p54nt7gm48ajqb2606f5801s'
    }
});

Python Example with requests

import requests

res = requests.get("https://api.stax.ai", headers={
    "Email": "[email protected]",
    "Authorization": "Bearer w3i21te088qskae7p54nt7gm48ajqb2606f5801s"
})

Authorization Failure

If your request was not able to be authenticated, your request will still be returned with the 200 HTTP Status (OK) code but you will receive the following JSON response:

{
    "success": false,
    "authError": true,
    "error": "Invalid authorization request"
}