Skip to main content
POST
video.tool.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_-]*$
description
string

When this tool should be called.

Required string length: 1 - 10000
parameters
object

JSON Schema for arguments, at most 10000 characters.

trigger
enum<string>

Run during the call or after it ends.

Available options:
in_call,
post_call
origin
enum<string>

Which part of the conversation invokes the tool.

Available options:
language,
vision,
audio
onCall
enum<string> | null

Behavior while awaiting a tool result.

Available options:
generate_filler,
static_filler,
silent,
passthrough
onResolve
enum<string>

Behavior after receiving a tool result.

Available options:
generate_response,
response_in_result,
add_to_context,
fire_and_forget
filler
string | null

Phrase spoken while waiting.

Required string length: 1 - 2000
delivery
enum<string>

Application message, platform callback, or connected service; only application messages are currently served.

Available options:
app_message,
callback,
service