Introduction
APIs and Models to initiate, monitor, and control your automation jobs
API
Here is the list of APIs existing under the Jobs category.
| API | Description |
|---|---|
| DeleteJobAsync | The API deletes an existing Job from the connected AI Command Center. |
| ExecuteJobAsync | The Smart Buddy executes an existing Job with provided job details from the connected AI Command Center and waits for the job to complete its execution. |
| ExecuteJobV2Async | Smart Buddy executes a predefined job using the provided job details from the connected AI Command Center. |
| GetAllAssistantBuddyJobsAsync | Gets the list of all Assistant Buddy JobsList information from the connected AI Command Center. |
| GetAllSmartBuddyJobsAsync | Gets the list of all Smart Buddy JobsList information from the connected AI Command Center. |
| GetJobInfoAsync | Gets the Job information with the specified Id from the connected AI Command Center. |
| GetJobStatusAsync | The API gets the job status with a specified Id from the connected AI Command Center. |
| GetJobsByAssistantBuddyIdAsync | The API gets the list of all jobs with specified Assistant Buddy Id from the connected AI Command Center. |
| GetJobsByBotIdAsync | The API gets the list of all jobs with specified Smart Buddy Id from the connected AI Command Center. |
| SubmitJobAsync | This API submits the job for execution in the AI Command Center and waits for the job to complete. |
| SuspendJobAsync | Suspends the job with specified SuspendedJobInfo details from the connected AI Command Center. |
| SubmitJobV2Async | This API submits the job for execution in the AI Command Center. |
Models
Here is a list of Models used in Jobs APIs.
| Models | Description |
|---|---|
| JobInfo | The structure represents an instance of the Job entity. |
| JobsList | The structure represents an instance of the JobsList entity. |
| NewJobInfo | The structure represents an instance of the New Job entity. |
| SuspendedJobInfo | The structure represents an instance of Suspend Job entity. |
| ViewJobInfo | The structure represents an instance of the View Job entity. |
| JobDetails | The structure represents an instance of the Job detail entity. |
| JobStartInfo | The structure represents an instance of the Job Start entity. |