Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
population
number

Population size

Required range: x >= 0
marginError
number

Margin of error (%)

Required range: 0.1 <= x <= 50
confidenceLevel
enum<string>

Confidence level

Available options:
80,
85,
90,
95,
99,
99.9
proportion
number

Expected proportion (%)

Required range: 1 <= x <= 99

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.