Submit Feasibility Request

curl --request POST \ --url https://api.userintuition.ai/api/public/v1/feasibility-requests/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "target_audience": "US startup CEOs who evaluated AI research tools in the past six months", "country_code": [ "US" ], "target": 20, "incident_rate": 8.5 } '

{ "id": "<string>", "target_audience": "<string>", "target": 123, "incident_rate": 123, "created_at": "2023-11-07T05:31:56Z", "status": "received", "country_code": [ "<string>" ], "study_id": "<string>", "estimated_total_cost_per_interview_usd": 123, "estimated_total_cost_usd": 123, "estimated_timeline_hours": 123, "responded_at": "2023-11-07T05:31:56Z", "cancelled_at": "2023-11-07T05:31:56Z", "expected_response_by": "2023-11-07T05:31:56Z" }

{ "detail": "<unknown>", "error": { "code": "<string>", "message": "<string>", "field": "<string>", "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "outcome": "not_started", "recovery_action": "<string>", "docs_url": "<string>" } }

Authorizations

Authorization

string

header

required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key

string | null

X-UI-Organization-ID

string | null

Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.

Maximum string length: 128

Body

application/json

target_audience

string

required

Description of the audience to recruit

Minimum string length: 1

target

integer

required

Target number of completed interviews

incident_rate

number

required

Expected audience incidence rate as percentage points (for example, 8.5 means 8.5%).

Required range: 0 <= x <= 100

country_code

enum<string>[] | null

Optional ISO 3166-1 alpha-2 country codes. Omit for no country restriction.

Available options:

AR,

AU,

AT,

BE,

BO,

BR,

CA,

CL,

CN,

CO,

CR,

CZ,

DK,

DO,

EC,

EG,

FI,

FR,

DE,

GR,

HK,

HU,

IN,

ID,

IE,

IT,

JP,

KE,

KR,

LU,

MY,

MX,

NL,

NZ,

NG,

NO,

PK,

PE,

PH,

PL,

PT,

RO,

RU,

SA,

SG,

SK,

ZA,

ES,

SE,

CH,

TW,

TH,

TR,

UG,

AE,

GB,

US,

VN

study_id

string | null

Optional existing study ID

Response

Successful Response

string

required

target_audience

string

required

target

integer

required

incident_rate

number

required

created_at

string<date-time>

required

status

enum<string>

required

Available options:

received,

responded,

cancelled

country_code

string[] | null

study_id

string | null

estimated_total_cost_per_interview_usd

number | null

estimated_total_cost_usd

number | null

estimated_timeline_hours

number | null

responded_at

string<date-time> | null

cancelled_at

string<date-time> | null

expected_response_by

string<date-time> | null

Review deadline when one has been committed; null means no deadline has been set.

Overview

Runnable examples

Studies

Interviews

Reference and usage

Platform administration

Participants

Reports

Targeting

Panels

External panels

Feasibility

Study Management

Webhooks

Submit Feasibility Request

Authorizations

Headers

Body

Response