FoxCueAPI Authentication: Bearer Keys and Scopes
Authenticate to the FoxCue API with a scoped workspace API key in the Authorization header. Key expiry, revocation and the full list of permission scopes.
Every FoxCue API request (except the discovery endpoints) needs a workspace API key in the Authorization header as a bearer token. Owners create keys in Settings → Developers. Each key has a name, an expiry and a set of scopes.
Authorization: Bearer <workspace API key>Send requests to https://app.foxcue.com/api/v1. https://app.foxcue.com is the hosted FoxCue app URL.
Rules
- Keys go in the
Authorizationheader only. Keys in URLs are never accepted. - Browser sign-in cookies can't authenticate the API, and keys can't sign in to the app.
- The full key is shown once. FoxCue stores only a hash.
- Keys expire after 1–365 days (default 90). The app offers 30 Days, 90 Days and 1 Year.
- Owners can revoke any key. Removing an owner, or resetting their sign-in, invalidates their keys.
- Use one key per integration.
See Create an API key for the steps.
Scopes
Scopes are independent: a key gets exactly what you select. For read-only access, select the :read scopes.
| Scope | Allows |
|---|---|
brands:read / brands:write | Brands, brand kits, offerings, CTAs, styles |
sources:read / sources:write | Sources and documents |
knowledge:read / knowledge:write | Source history, passage search, context, people |
strategy:read / strategy:write | Silos, topics, targets, evidence, briefs |
performance:read / performance:write | YouTube connections, publications, reports, sync jobs |
scripts:read / scripts:write | Scripts, versions, collections |
outputs:read | Saved outputs |
generation:write | Start AI generation and renders. Can incur provider charges. |
jobs:read / jobs:write | Poll jobs / cancel jobs |
media:read / media:write | Download / upload files |
Existing keys don't gain new scopes automatically when new ones are added.
Frequently asked questions
Are API keys the same as my OpenAI or ElevenLabs keys?
No. Workspace API keys only access FoxCue. AI provider keys are configured on the server.