Skip to main content
POST
Execute a Computer Task and wait for its result

Authorizations

token
string
query
required

Vida API Token

Path Parameters

targetAccountId
integer
required

Selected Computer Agent account.

Required range: x >= 1

Body

application/json
taskContext
string
required

Instructions for the Agent performing this Task.

Minimum string length: 1
Example:

"Confirm whether the customer wants a renewal quote."

waitSeconds
integer
default:60
Required range: 0 <= x <= 60
title
string

Optional Task title.

externalTaskId
string

Caller correlation ID, not an idempotency key.

meta
object

Ordinary Task reporting metadata, not added to the Agent prompt.

Response

Reply ready, or Task errored or canceled

success
boolean
required

Whether the API request succeeded, not whether the Task succeeded.

Example:

true

taskId
string
required

Existing Task ID.

state
enum<string>
required
Available options:
pending,
processing,
running,
finished,
errored,
canceled
resultStatus
enum<string>
required

Response-only readiness. Finished Tasks remain pending while their reply has not replicated. Unavailable indicates an errored or canceled Task.

Available options:
pending,
ready,
unavailable
output
object | null
required
error
object | null
required
resultRef
object
required