Documentation
Sign inGet started

Create a Realtime app key

POST
/v1/realtime/apps/{realtime_app_id}/keys
curl -X POST "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/keys" \
  -H "Authorization: Bearer $TOKEN"
Adds a new key to the app and returns it with its secret. The secret is included in this response only and is never returned again — store it now. Use this together with revoke for zero-downtime rotation: add a key, roll it out across your clients, then revoke the old key.
Response Payload
id
string
required
key
string
required
The public app key clients use to connect.
secret
string
The key secret, used for server-side request signing. Returned only when the key is created, and never shown again — store it securely. If lost, create a new key and revoke this one.
revoked_at
nullable string
required
When the key was revoked, or null if still active.
created_at
string
required