Skip to main content
GET
List Content Briefs in the active workspace

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Query Parameters

cursor
string

meta.cursor of the previous page

limit
integer

Page size, default 25, max 100

Required range: 1 <= x <= 100
state
enum<string>

Deprecated: the stored state (pending, generating, generated, failed). Only without list options; use status on each Brief, or runState.

Available options:
pending,
generating,
generated,
failed,
new,
approved,
ready
language
string

Without list options: the Brief's own language, exactly. With list options: a language of its markets (repeatable).

List option: text in the title, keyword, notes or category

Maximum string length: 300
sort
enum<string>

List option: sort key, default createdAt

Available options:
createdAt,
title,
keyword
direction
enum<string>

List option: default desc

Available options:
asc,
desc
view
enum<string>

List option: progress (the Run is queued or running), drafted (it completed), active (not paused) or all (default)

Available options:
all,
progress,
drafted,
active
runState
enum<string>[]

List option: the state of the Brief's Run (run.state), not_started for none, or paused. Repeatable.

Available options:
not_started,
queued,
running,
completed,
partial,
failed,
cancelled,
paused
intent
string[]

List option: the Brief's intent. Repeatable.

market
string[]

List option: a market of the Brief (country code or market name). Repeatable.

Response

Paginated Content Briefs

data
object[]
required
meta
object
required