Cereal docs
Deploy and monitor

Troubleshooting

Diagnose setup, streaming, tool, and deployment problems by their symptoms.

SymptomCheckNext action
SDK installation failsThe starter uses a repository workspace packageFollow TypeScript setup, or use HTTP
Client construction fails before a requestCEREAL_API_KEY is missing; the SDK does not load the CLI loginPass the credential in the server process
Setup works but starting a session is forbiddencontrol does not imply data or readCheck the operation's required scopes in credentials
An API key reports environment_mismatchA header conflicts with the key’s environmentRemove the selector or use the intended environment’s key
Agent cannot call a local toolThe application development channel stoppedRestart cereal dev or the starter; inspect connection status
Production callbacks return 401Origin, path, body bytes, or expected tenancy differCheck verification and the mounted endpoint
Token minting fails with a read-only keysessions.streamToken requires dataMint on an authorized application server with the correct scope
Browser stream returns 401Token expired or was not renewedUse a token-source function in subscribe
Browser stream returns 400Requested format differs from the token's pinned formatUse the same format in issuance and subscription
Chat is empty after reloadA cursor was saved without the transcriptReplay from the beginning or persist both state and cursor
Session is idle but there is no final answerThe stop reason is not completedInspect stopReason, pending approvals, and trace
Approval returns a conflictAnother action answered, expired, or superseded itRefresh pending decisions; do not retry indefinitely
An SDK method is undefinedThe HTTP operation may not have a wrapperCheck TypeScript signatures and coverage
Copy to environment cannot resolve dependenciesThe target is missing named resourcesConfigure target resources or change the reference mappings, then check again

For support, include the environment, session ID, operation name, error tag, and request or trace ID when available. Keep API keys, model keys, and stream tokens out of reports.