Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Send your API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

​
template_id
string
required

Public Bot template identifier.

Body

application/json
​
input
object
required

Run input object. Its shape must conform to the template input_schema; use an empty object when no inputs are required.

​
proxy_region
string

Optional proxy region code returned by the regions endpoint.

Example:

"US"

​
callback_url
string<uri>

Optional. HTTP/HTTPS URL to receive a POST notification when the task finishes, fails, or is canceled. Maximum length: 2048 characters. Must be publicly reachable (no private/local addresses).

Maximum string length: 2048
​
status_change_callback_url
string<uri>

Optional. HTTP/HTTPS URL to receive a POST notification whenever the task status changes (e.g., running, paused, finished, canceled, failed). Maximum length: 2048 characters. Must be publicly reachable (no private/local addresses).

Maximum string length: 2048

Callbacks

POST
{$request.body#/callback_url}runCompleted

Body

application/json
​
task_id
string
required

Task ID

​
log_detail_url
string<uri>
required

URL to detailed execution logs for this task.

​
bot_type
enum<string>
required

Public bot type. agent represents SkillFlow, not the legacy Agent app type.

Available options:
workflow,
agent
​
status
enum<string>
required

Public lifecycle status of a bot run.

Available options:
created,
running,
finished,
canceled,
pausing,
paused,
failed
​
created_at
string<date-time>
required

Task creation time

​
input
object
required

Input object accepted for this run.

​
bot_id
string

Public bot identifier used by a normal Bot run.

​
bot_name
string

Bot display name when available for a normal Bot run.

​
finished_at
string<date-time>

Task finish time (if ended)

​
task_failure_info
object
​
output
any | null

Present only when the task has ended.

​
output_files
object

Business result files keyed by format, for example json, md, csv or xml.

​
download_files
object[]

Files generated by the task (if any).

​
files_expires_at
integer<int64>

Expiration timestamp for download files.

​
steps
object[]

Steps executed within the task.

​
live_url_info
object

Present only when the task is running.

​
credit
integer<int64>

Credits consumed by this task.

Response

200

Callback accepted.

POST
{$request.body#/status_change_callback_url}runStatusChanged

Body

application/json
​
task_id
string
required

Task ID

​
log_detail_url
string<uri>
required

URL to detailed execution logs for this task.

​
bot_type
enum<string>
required

Public bot type. agent represents SkillFlow, not the legacy Agent app type.

Available options:
workflow,
agent
​
status
enum<string>
required

Public lifecycle status of a bot run.

Available options:
created,
running,
finished,
canceled,
pausing,
paused,
failed
​
created_at
string<date-time>
required

Task creation time

​
input
object
required

Input object accepted for this run.

​
bot_id
string

Public bot identifier used by a normal Bot run.

​
bot_name
string

Bot display name when available for a normal Bot run.

​
finished_at
string<date-time>

Task finish time (if ended)

​
task_failure_info
object
​
output
any | null

Present only when the task has ended.

​
output_files
object

Business result files keyed by format, for example json, md, csv or xml.

​
download_files
object[]

Files generated by the task (if any).

​
files_expires_at
integer<int64>

Expiration timestamp for download files.

​
steps
object[]

Steps executed within the task.

​
live_url_info
object

Present only when the task is running.

​
credit
integer<int64>

Credits consumed by this task.

Response

200

Callback accepted.

Response

Template run created.

​
task_id
string
required

Task ID

​
status
enum<string>
required

Public lifecycle status of a bot run.

Available options:
created,
running,
finished,
canceled,
pausing,
paused,
failed