Get an API Key
1. Prerequisites
Before using Rokid OpenAPI, activate an enterprise account on the Rokid platform and obtain an API Key for authentication.
2. Obtaining an API Key
Contact your sales or business counterpart and request OA approval for an enterprise account and an API Key. This documentation consistently uses API Key for the OpenAPI authentication credential.
3. Using the API Key
- Include it in requests for authentication via the HTTP headers below.
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <API_KEY> |
- Do not expose API Keys in public repositories or clients to avoid security or billing risks.
4. Lifetime
Created API Keys expire. You can configure validity when provisioning; default validity is 1 month.
FAQ
Q: How many keys can one enterprise account create?
A: There is currently no hard cap, but prefer one key per app or service to limit blast radius if a key leaks.Q: After the company is deregistered, do keys still work?
A: No. All keys issued to that account become invalid for OpenAPI calls.