Skip to main content
POST
Write the AI context from a company domain

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for starting a run that writes the business context from a company domain.

domain
string | null

A company domain like 'acme.com' (a full address or URL is read down to its domain); every field is written from it. Left out, the run reads the company domain in the signed-in user's email address and fills only the fields still empty when it lands.

Required string length: 1 - 255

Response

Successful Response

A generation job's current state. Poll this until status is terminal.

created_at
string<date-time>
required
domain
string
required

The domain this job is researching.

error
string | null
required

Why generation failed: infra trouble, or too little public content.

id
string<uuid>
required
status
enum<string>
required

Where a context-generation job has got to.

Jobs are born RUNNING: creation validates, inserts and queues the workflow in one call, so there is no separate committed-but-not-started phase. PENDING exists for schema parity with the other job enums and is never observed. The two terminal states are absorbing: a job never leaves them.

Available options:
pending,
running,
succeeded,
failed
updated_at
string<date-time>
required
steps
AiStep · object[]

What the research did, one step per piece of work once it is done: the documents and pages it read, the sections it wrote. Grows while the job runs; kept once it finishes.

Maximum array length: 40