Skip to main content
POST
media.consent.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
language
enum<string>
required

Language of the three word consent challenge.

Available options:
dutch,
turkish,
swedish,
indonesian,
filipino,
czech,
romanian,
danish,
malay,
slovak,
croatian,
english,
polish,
german,
spanish,
french,
italian,
portuguese

Response

The result

text
string
required

Three word challenge to say in the recording.

createdAt
string
required

Creation time, ISO 8601 UTC.

challengeExpiresAt
string
required

Challenge expiry, 30 minutes after creation.

ref
string

Reference to what this call created. Pass it as ref to media.consent.attach, media.consent.get or media.consent.delete.