Skip to content
For AI agents: a documentation index is available at /llms.txt. Every docs page is also available as markdown: add .md to its URL. To connect, read /agents.md.

Errors

key_scope_insufficient

A read-only key tried a paid call or a write.

Status

HTTP 403, title Key scope insufficient. One of the credentials errors. Branch on code, never on the status or the prose.

Retryable: no. Every body carries this as retryable: false, beside action and remedy: the same request will fail again until the request changes or a person acts.

Common causes

  • The key was created read-only in the console.

What to do

Action: Use a full API key, or send estimate=true to quote it.

A read-only key makes free reads and estimates only. Use a full key; retrying will not help.

Example

The body arrives as application/problem+json, with retryable and the remedy above. Most responses add detail about the occurrence, and some add fields of their own.

{
  "type": "https://www.shortsintel.com/docs/reference/errors/key_scope_insufficient",
  "title": "Key scope insufficient",
  "status": 403,
  "code": "key_scope_insufficient",
  "retryable": false,
  "action": "Use a full API key, or send estimate=true to quote it.",
  "remedy": "A read-only key makes free reads and estimates only. Use a full key; retrying will not help."
}