Skip to main content
POST
companies.research-bulk

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
rows
object[]
required

Unique company-domain rows, up to 100.

Required array length: 1 - 100 elements
question
string
required

Company research question.

Required string length: 1 - 4000
priorResults
object[]

Optional previous answers for companies in this run.

Maximum array length: 100
context
enum<string>
default:website

Research context; default website.

Available options:
domain,
profile,
website

Explicit web search; requires configured search service.

searchDepth
enum<string>
default:low

Search depth; higher options explicit.

Available options:
low,
medium,
high
typedColumns
boolean
default:false

Typed answers require a configured judgment service.

includeConfidence
boolean
default:false

Request confidence bands.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.