Studio API Resource Guide

Documentation

Studio API documentation is published on the Studio API documentation web site.

Here are some tips to using the Studio API documentation web site.

The initial language is cURL. You can change this as shown in the illustration.
You can run the APIs in Postman and save them as a collection.

Base URL

These are the base URLs for each Studio 7 instance.

Studio 7 Instance	Base URL
US	api.us7.studioportal.io/api
EU	api.prod.eu.five9.net/studio-backend/api

API Headers for Studio Account Users

API headers authenticate your access to Studio.

Header	Description
Scope	Your Studio account can access the ac scope.
Scope Id	Supply your Studio account Id. If you don't know your Studio account Id, log in to the Studio interface and navigate to Studio Manage \| Account Profile.
Studio API Key	Supply a Studio API key generated for your Studio account. You will see an error if the Studio API key and Scope Id don't match. Log in to your Studio account to generate a Studio API key. Assign permissions to the key in line with the actions you want it to perform. See Studio Manage \| API Keys.

Header

Description

Scope

Your Studio account can access the ac scope.

Scope Id

Supply your Studio account Id. If you don't know your Studio account Id, log in to the Studio interface and navigate to Studio Manage | Account Profile.

Studio API Key

Supply a Studio API key generated for your Studio account. You will see an error if the Studio API key and Scope Id don't match.

Log in to your Studio account to generate a Studio API key. Assign permissions to the key in line with the actions you want it to perform. See Studio Manage | API Keys.

Note:

If your API key is compromised, delete the key from your Studio account to prevent misuse.

If you are a service provider, see Studio API Resource Guide for Service Providers.

Rate Limits for API Calls

When using Studio public APIs, ensure that your application operates within these limits.

API Route	Rate Limit
2FA API	60 API calls per minute for each client IP address and Studio user email. The rate limit applies to all the Studio user's email addresses. The Studio user can reach the limit with any one email address or a combination of their email addresses.
Manage Passwords Reset password Validate password Forgot password	200 API calls per minute for each client IP address.
Log in to Studio	The maximum number of failed attempts is taken from the web security settings, set for the Studio instance by the system user. The rate applies to the client IP address and Studio user email. The rate limit applies to all the Studio user's email addresses. The Studio user can reach the limit with any one email address or a combination of their email addresses.

API Route

Rate Limit

2FA API

60 API calls per minute for each client IP address and Studio user email.

The rate limit applies to all the Studio user's email addresses. The Studio user can reach the limit with any one email address or a combination of their email addresses.

Manage Passwords

Reset password
Validate password
Forgot password

200 API calls per minute for each client IP address.

The maximum number of failed attempts is taken from the web security settings, set for the Studio instance by the system user.

The rate applies to the client IP address and Studio user email. The rate limit applies to all the Studio user's email addresses. The Studio user can reach the limit with any one email address or a combination of their email addresses.