How to generate an API key
Our API uses header-based authentication. Each request must include a key in the headers to verify your identity and permissions. You can create and manage API keys through the Quartr Portal.Log in to the Portal
Access your account by logging into the Quartr
Portal.
Use the API key in requests
Include the key in the request headers using
x-api-key as the header name.Test the API key
Try your new key by exploring the API Reference.
Dataset access
Your access to datasets is determined by your subscription plan. Each API key inherits the permissions of your plan. Accessing datasets outside your plan results in a403 Forbidden error.
If you are trying to access the /documents endpoint, make sure you have permission to access all three document types: reports, slides, and transcripts. Missing any one of these permissions will result in a 403 error. The same applies to the /live endpoint, which requires access to both live transcripts and live audio.
If you have purchased the correct data packages and still receive a 403 error, contact your Quartr representative.
API key management
API keys do not have an expiration date by default. You can delete them at any time from the “API keys” section in the portal, which immediately revokes access.Rate limits
Each API key is subject to rate limits based on your subscription plan. The default rate-limit is 50 requests per second. If you exceed the allowed number of requests, you will receive a429 Too Many Requests response. The rate limit resets after a certain period, which is specified in the response headers.
If you need a higher rate limit, please contact your Quartr representative to discuss options for increasing your limits based on your use case and subscription plan.