These operations are copied from the live OpenAPI schema at GET /api/v1/openapi.json (2026-10-28, 297 operations). Each example request is built from that operation's schema: required fields, and optional fields when the object is small. Response bodies are not in that schema. Where the JSON shape is known, it is listed below with an example. Shared errors are on Limits and errors.

Send Authorization: Bearer <workspace API key>. Base URL: https://app.foxcue.com/api/v1.

WorkflowsCopy Anchor Link

GET /workflows/searchCopy Anchor Link

Search one bounded workspace record family; additionally requires the selected family read scope

Scope: brands:read.

ParametersCopy Anchor Link

Example requestCopy Anchor Link

curl -X GET "https://app.foxcue.com/api/v1/workflows/search?kind=example&query=example&project_id=example&limit=example" \
  -H "Authorization: Bearer <workspace API key>"

ResponseCopy Anchor Link

The body is a JSON object with these fields.

{
  "kind": "example",
  "items": [],
  "has_more": false,
  "limit": 0
}

POST /workflows/video-ideasCopy Anchor Link

Resolve or import one public article and queue the existing bounded article-focused idea planner; also requires strategy:read, knowledge:read/write and generation:write

Scope: strategy:write.

Example requestCopy Anchor Link

{
  "project_id": "example",
  "silo_id": "example",
  "url": "example",
  "source_id": "example",
  "count": 1,
  "target_ids": [
    "example"
  ],
  "idempotency_key": "example-"
}

Required fields: project_id, silo_id, idempotency_key.

curl -X POST "https://app.foxcue.com/api/v1/workflows/video-ideas" \
  -H "Authorization: Bearer <workspace API key>" \
  -H "Content-Type: application/json" \
  -d @body.json

ResponseCopy Anchor Link

GET /workflows/video-ideas/{id}Copy Anchor Link

Read source-to-ideas workflow and its existing decision run; additionally requires knowledge:read

Scope: strategy:read.

ParametersCopy Anchor Link

Example requestCopy Anchor Link

curl -X GET "https://app.foxcue.com/api/v1/workflows/video-ideas/example" \
  -H "Authorization: Bearer <workspace API key>"

ResponseCopy Anchor Link

POST /workflows/script-from-ideaCopy Anchor Link

Create one durable native script from a brand and idea, with pinned public evidence and a finite cost cap; requires scripts:write, knowledge:read and generation:write when generating

Scope: strategy:write.

ParametersCopy Anchor Link

Example requestCopy Anchor Link

{
  "project_id": "example",
  "idea": "example",
  "idempotency_key": "example-",
  "knowledge_ids": [
    "example"
  ],
  "idea_id": "example"
}

Required fields: project_id, idea.

curl -X POST "https://app.foxcue.com/api/v1/workflows/script-from-idea" \
  -H "Authorization: Bearer <workspace API key>" \
  -H "Idempotency-Key: example-key-001" \
  -H "Content-Type: application/json" \
  -d @body.json

ResponseCopy Anchor Link

GET /workflows/idea-workflows/{id}Copy Anchor Link

Inspect idea-to-script work after rechecking current actor, brand and evidence access

Scope: scripts:read.

ParametersCopy Anchor Link

Example requestCopy Anchor Link

curl -X GET "https://app.foxcue.com/api/v1/workflows/idea-workflows/example" \
  -H "Authorization: Bearer <workspace API key>"

ResponseCopy Anchor Link

POST /workflows/idea-workflows/{id}/cancelCopy Anchor Link

Cooperatively cancel idea script generation while retaining its saved draft

Scope: scripts:write.

ParametersCopy Anchor Link

Example requestCopy Anchor Link

curl -X POST "https://app.foxcue.com/api/v1/workflows/idea-workflows/example/cancel" \
  -H "Authorization: Bearer <workspace API key>"

ResponseCopy Anchor Link

Related articlesCopy Anchor Link

• All operations
• Authentication and scopes
• Limits and errors
• Jobs and idempotency