Start Job
Overview
Start a job using a process and a Buddy.
Endpoint
POST /api/job/start
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
waitForResult | boolean | See notes | The example uses false. Confirm waiting behavior before using true. |
ticks | integer | See notes | The example uses 0. Units, bounds, and timeout behavior require deployment-specific verification. |
The example supplies all parameters listed above. Omission behavior and server defaults are not established by this reference; confirm them for your deployed version.
Request body
| Parameter | Type | Requirement | Description |
|---|---|---|---|
processId | integer | See notes | Process ID returned by Get Process Definition. |
botId | integer | See notes | Buddy ID returned by Get SmartBuddy by Name for a SmartBuddy job. |
inputArguments | string | See notes | Serialized process input arguments. The example uses an empty string. |
logLevel | string | See notes | Logging level; the example uses Trace. |
isAssistantBuddyJob | boolean | See notes | Use false for a SmartBuddy job or true for an AssistantBuddy job. |
Types reflect the example below. Unless marked required, field requirements, defaults, and validation limits need confirmation for your deployed version.
{
"processId": 8,
"botId": 3,
"inputArguments": "",
"logLevel": "Trace",
"isAssistantBuddyJob": false
}
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request POST \
--url 'https://command-center.example.com/api/job/start?waitForResult=false&ticks=0' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"processId": 8,
"botId": 3,
"inputArguments": "",
"logLevel": "Trace",
"isAssistantBuddyJob": false
}'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"jobId": 60,
"tenantId": 1,
"processId": 8,
"processName": "HelloWorldProcess",
"botId": 3,
"botName": "ib-41_buddy",
"startedAt": "2024-07-10T13:51:07.047123",
"assignedAt": "2024-07-10T13:50:47.285543",
"endedOn": "2024-07-10T13:51:18.49368",
"execStatus": "Completed",
"input": "",
"output": "{}",
"logLevel": "Trace",
"isDynamic": false,
"isAssistantBuddyJob": false,
"initiator": null,
"initiatorType": null,
"initiatorName": "demouser1 1",
"executionTime": 11,
"isResubmitted": false,
"parentJobId": null,
"parentInstanceId": null,
"activityInstanceId": null,
"activityId": null,
"created": "2024-07-10T13:50:20.519733",
"modified": "2024-07-10T13:51:18.51828",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
}
Use the returned jobId with Get Job Status. The response illustrates a completed job; it does not guarantee completion when waitForResult=false. Waiting behavior, polling intervals, and the full status set require verification.
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
jobId | integer | ID of the job. |
tenantId | integer | ID of the tenant. |
processId | integer | ID of the process definition. |
execStatus | string | Job execution status; the example uses Completed. |
input | string | Job or task input; consult the process definition for its structure. |
output | string | Job or task output; consult the process definition for its structure. |
activityInstanceId | null | ID of the activity execution. |
activityId | null | Activity identifier from the process definition. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.