Skip to main content
POST
video.agent.get

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
name
string
required

Your own unique name for this resource; keep it unchanged for later calls.

Required string length: 1 - 64
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$

Response

The result

name
string
required

Your own unique name for this resource; keep it unchanged for later calls.

Required string length: 1 - 64
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
systemPrompt
string
required

Instructions for the conversational agent; may contain personal information.

Required string length: 1 - 20000
greeting
string

Opening greeting.

Required string length: 1 - 2000
dynamicGreeting
boolean

Generate a greeting from context.

pipeline
enum<string>

Full conversation or repeat supplied speech.

Available options:
full,
echo
languages
string[]

Languages the conversation may use.

Maximum array length: 42
Required string length: 1 - 16
objectiveSet
string | null

Name of your objective set to link.

Required string length: 1 - 64
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
guardrails
string[]

Names of your guardrails to link; empty removes all.

Maximum array length: 50

Your own unique name for this resource; keep it unchanged for later calls.

Required string length: 1 - 64
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
disclosure
enum<string>

When to disclose that the speaker is automated.

Available options:
always,
auto,
off
verbalDisclosure
string

Spoken disclosure text.

Required string length: 1 - 2000
visualDisclosure
string

Visible disclosure text.

Required string length: 1 - 2000