The Scale Registry designed to be used to store and distribute compiled Scale Functions. The Scale Registry is a RESTful API and has an OpenAPI Specification available at https://api.scale.sh/v1/swagger.json.

Using the Scale Registry is completely free during our beta period. To learn more about our future plans for the Scale Registry, please join the #scale channel on our Discord.

Most interactions with the Scale Registry can be done using the Scale CLI, which is the recommended method of interacting with the API.

​
Authentication

The Scale Registry can be authenticated using a Cookie which is returned from the Authentication API, or by sending an API Key in the Authorization header.

We do not recommend using the Cookie authentication method yourself - the Scale CLI will handle this for you when you authenticate with it. Instead, we recommend using the API Key authentication method.

​
API Key Authentication

API Keys can be created by the Scale CLI and used by sending an Authorization: Bearer <API Key> header with each request.

curl --request POST \
     --url https://api.scale.sh/v1/userinfo \
     --header 'Authorization: Bearer <API Key>'

You can also use the built-in API Client to experiment with the Scale Registry API from your browser.

The Scale Registry can be authenticated using a Cookie which is returned from the Authentication API. The Cookie must be sent with each request, and the API will periodically refresh the Cookie in the returned response.

To get an Authentication Cookie, head to https://scale.sh/login and enter your log in information. Once you’re redirected to the success page, you can copy the auth-session Cookie from your browser’s developer tools.

Next.jsGet User Info