Skip to main content
POST
Research brief

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
domain
string
required

Research domain. GET /api/research/domains lists them.

Required string length: 1 - 60
topic
string
required

The question the brief should answer.

Required string length: 1 - 2000
context
string

What you already know, so it is not repeated.

Maximum string length: 8000
methodology
string

How you want it researched, if it matters.

Maximum string length: 500
outputFormat
string

Shape of the brief, e.g. memo, outline.

Maximum string length: 60
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

research
any
required

The brief, with its sources.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any