API System Tour

Choose a path.

Each path organizes the required requests in sequence so you can confirm parameters, examine responses, and leave with a working example for your implementation.

Work through the flow steps.

Create an API key

Generate credentials for your account so your requests can be authenticated.

Create a key for a specific project, assign the resources it can access, and define a monthly request limit. Store the generated key securely and treat it like a password.

To retrieve existing keys, visit .

Name of the project this key will be used for.
Description of the project this key will be used for.
Maximum API requests allowed for this key each month. Set to 0 for no key-specific limit; your account-wide maximum still applies.
Which APIs this key has permission to access.

Loading required resources for the selected API path...

Use the search field to filter resources. Selected items are applied to the API key you create.

Loading available resources for your account...

Credit Usage Summary

Track usage for the active API key with a single summary that refreshes every 5 minutes.

Credit tracking starts when you make your first API request. The app captures a baseline from /accountcontrol/getusage before that first request, then refreshes the same endpoint every 5 minutes. Because usage updates are delayed, the values below may reflect multiple requests at once instead of updating immediately after each call.

Make an API request to start credit tracking.

Credits Used Since Last Refresh

Waiting for usage data

Credits Used This Session

Waiting for usage data

Total Credits Used By This Key

Waiting for usage data

How these amounts are calculated

The summary is idle until the first API request is made.

Review the credit model in .

Visit the My Account page

Review your keys, usage, and other app access.

After testing your requests, use the My Account page to create and manage API keys and explore the other apps your CQA account grants you access to.