FoxCueFoxCue REST API: Overview and Quickstart
Use the FoxCue REST API to work with brands, sources, scripts, outputs and recordings from code. Scoped bearer keys, OpenAPI schema and async jobs.
The FoxCue API lets your code use the same brands, sources, scripts and outputs as your workspace. It's a versioned REST API under /api/v1. You authenticate with a scoped workspace API key, and long-running work (scripts, articles, slides, narrated videos) runs as asynchronous jobs.
Base URL
https://app.foxcue.com/api/v1https://app.foxcue.com is the hosted FoxCue app URL, so the API lives at https://app.foxcue.com/api/v1. Settings → Developers also shows the API base URL for your workspace.
Quickstart
Create a key
A workspace owner creates a key in Settings → Developers with the scopes you need. See Authentication and API keys.
List your brands
curl "https://app.foxcue.com/api/v1/projects?limit=20" \
-H "Authorization: Bearer <workspace API key>"Queue a job
curl "https://app.foxcue.com/api/v1/jobs" \
-H "Authorization: Bearer <workspace API key>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: article-request-001" \
-d '{"operation":"article.generate","input":{"script_id":"<script id>","body":"<your script>"}}'A successful request returns 202 with a job ID. Poll GET /jobs/{id} for progress and results. See Jobs and idempotency.
Discovery endpoints
These need no key and return no account data:
| Endpoint | Returns |
|---|---|
GET /capabilities | What this server supports |
GET /openapi.json | The full OpenAPI schema: routes, request schemas and required scopes |
GET /docs | A quick reference |
What you can do
| Area | Operations |
|---|---|
| Brands/products | Create, read, update and delete brands, plus offerings, CTAs and writing styles |
| Brand kit | Read the approved kit, import website or image candidates, import a raster logo, approve with expected_revision |
| Sources | Knowledge documents, revisioned text and single public URL import |
| Knowledge | Source history, passage search, reviewed context and people |
| Strategy | Silos, topics, query targets, evidence, briefs, coverage and context snapshots |
| Performance | Visible YouTube connections, imported publications, content links, cached reports and queued sync/report jobs |
| Scripts | Create, read, update and delete scripts, collections, version reads and snapshots |
| Generate | script.generate, script.generate_long, article.generate, slides.generate, video.render |
| Outputs | Saved artifacts, article text, slide models and media downloads |
| Recordings | Create recording sessions and upload raw tracks |
| Jobs | List, poll and cancel |
See Operations for details.
Not available through the API
- Account sign-in, provider settings and Google/YouTube authorization. These are browser-only.
- Webhooks. Poll jobs instead.
- Publishing to YouTube.
Frequently asked questions
Is there an SDK?
Not yet. Use the OpenAPI schema at /openapi.json to generate a client.
Can my AI agent use FoxCue?
Yes. Use the API directly, or connect an assistant through the local MCP server.