Read a stream key
Read the stream key for a product the account is entitled to: the Standard key, or the separate Ultra Speed key. Store it in an environment variable; never put it in a URL or a log.
POST
/api/agent/credentialsAuthorization
AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key:Bearer <key>.
Headers
X-TweetStream-Setup-ProofstringheaderrequiredThe setupProof returned by email verification. It lasts 30 minutes; after that, verify a new email code.
Body
familyenum<string>required
Response fields
apiKeystringrequiredcreatedAtstringrequireda string to be decoded into a DatecredentialScopeenum<string>requiredfamilyenum<string>required
Responses
- 200Success
- 400Invalid request, wrong code, or the Terms were not accepted
- 401Missing or invalid API key, or the setup proof is missing or expired
- 403The account is restricted, or the request carried a foreign Origin
- 404No such checkout or link, or the account has no entitlement for this product
- 429Rate limit or activation budget reached; retry after retryAfterSeconds
- 503Temporarily unavailable; retry later