Skip to main content
POST
Create a new task

Authorizations

token
string
query
required

Vida API Token

Body

application/json
type
enum<string>
required
Available options:
call
target
string
required

Phone number, email address, or supported Vida username for this Task type.

Example:

"+15551234567"

accountId
integer

Agent account that performs the Task.

Example:

1234

title
string
context
string

Contact context supplied to the Agent.

taskContext
string

Instructions for the Agent performing this Task.

Example:

"Confirm whether the customer wants a renewal quote."

scheduledFor
integer

Unix timestamp for the first attempt or Computer Agent run.

Example:

1712350000

externalTaskId
string

Reusable caller-defined correlation ID; not an idempotency key.

contactListName
string
goal
object | null

Task-specific outcome definition. Omit or pass null to inherit the organization default.

retryPolicy
object | null

Task-specific cadence. Omit or pass null to inherit the organization default. Use delaysSeconds or steps, never both.

meta
object

Metadata retained for filtering and reporting; it is not added to the Agent prompt.

greeting
string

Call greeting. Prefix with prompt: to generate it from an instruction.

waitToGreet
boolean

Response

Task created successfully