Skip to main content
POST
Start a screening interview

Authorizations

Authorization
string
header
required

User JWT token passed in Authorization header

Headers

X-Permission-Info
string

Required JWT permission: screen (informational only -- enforced server-side)

Query Parameters

test
enum<integer>
default:0

Set to 1 to mark as test screen

Available options:
0,
1

Body

application/json
council_sage_id
string<uuid>
required

UUID of the council sage to use for screening

council_id
string<uuid>
required

UUID of the council

sage_name
string | null

Optional display name override for the sage

image
string | null

Base64-encoded reference image for verification

Response

Screen started with opening prompt

screen_id
string<uuid>

UUID of the created screen

message
string

Opening prompt / greeting from the sage

council_sage_id
string<uuid>

UUID of the council sage used