Skip to main content
POST
Research brief

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
domain
enum<string>
required

Research lens. math is rigorous theory; ml focuses on foundations and optimization; ai-safety on alignment and interpretability; general on evidence-based synthesis.

Available options:
math,
ml,
ai-safety,
general
topic
string
required

The question the brief should answer.

Required string length: 1 - 2000
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
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
enum<string>

Shape of the brief: analysis, paper, or summary. Defaults to analysis.

Available options:
analysis,
paper,
summary

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

research
object
required

The brief, with its sources. The text is under result.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

{key}
any