Robot task runs, also known as robot jobs, are individual executions of a robot task. For example, for any given robot task, you can schedule a task run once every 24 hours, or you can initiate a task run manually at any time.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/wegalvanize:wegalvanize-robot-jobs-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HighBond API Reference Robot Jobs API
version: 1.1.0
description: Welcome to the API documentation for HighBond.
x-logo:
url: ./assets/logo.png
altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
variables:
protocol:
default: https
server:
default: apis-us.highbond.com
enum:
- apis-us.highbond.com
- apis-ca.highbond.com
- apis-eu.highbond.com
- apis-ap.highbond.com
- apis-au.highbond.com
- apis-af.highbond.com
- apis-sa.highbond.com
- apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Robot Jobs
x-displayName: Robot task runs
description: Robot task runs, also known as robot jobs, are individual executions of a robot task. For example, for any given robot task, you can schedule a task run once every 24 hours, or you can initiate a task run manually at any time.
paths:
/orgs/{org_id}/robots/{robot_id}/jobs:
get:
tags:
- Robot Jobs
operationId: getRobotJobs
summary: List robot task runs
description: Get a list of task runs for a robot.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/robotIdParam'
- $ref: '#/components/parameters/robotEnvParam'
- $ref: '#/components/parameters/robotJobsIncludeParam'
- $ref: '#/components/parameters/robotPageSizeParam'
- $ref: '#/components/parameters/robotPageNumberParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/GetRobotJobsResponse'
example:
data:
- id: '1'
type: robot_jobs
attributes:
app_version: 1
completed_at: '2019-03-21T20:32:48.282Z'
count: 1
delete_failed: false
discarded_at: null
environment: production
error_code: null
queued_at: '2019-03-21T20:22:48.282Z'
result_analytics:
- name: Test HB robot flow
logs:
- key: 1234567\/12345\/audit_logs.json
file_name: Test task.json
success: true
result_downloadable: true
status: success
trigger_type: schedule
agent_count: null
relationships:
robot:
data:
id: '1'
type: robot
task:
data:
id: '1'
type: task
triggered_by:
data:
id: '1'
type: user
- id: '2'
type: robot_jobs
attributes:
app_version: 1
completed_at: '2019-03-21T20:52:48.282Z'
count: 2
delete_failed: false
discarded_at: null
environment: production
error_code: null
queued_at: '2019-03-21T20:42:48.282Z'
result_analytics:
- name: Test HB robot flow
logs:
- key: 1234567\/12345\/audit_logs.json
file_name: Test task.json
success: true
result_downloadable: true
status: success
trigger_type: schedule
agent_count: null
relationships:
robot:
data:
id: '1'
type: robot
task:
data:
id: '1'
type: task
triggered_by:
data:
id: '1'
type: user
links:
prev: /v1/orgs/{org_id}/robots/{robot_id}/jobs?env={env}&page[size]=2&page[number]=1
next: /v1/orgs/{org_id}/robots/{robot_id}/jobs?env={env}&page[size]=2&page[number]=3
'400':
$ref: '#/components/responses/MissingRobotId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
/orgs/{org_id}/robots/jobs/{job_id}:
delete:
tags:
- Robot Jobs
operationId: deleteRobotJobs
summary: Delete robot task run
description: Delete a single robot task run.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/robotJobIdParam'
responses:
'200':
description: OK.
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: Unprocessable entity.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/RobotsError'
components:
schemas:
RobotJob:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the task run.
example: 1
type:
type: string
description: The classification of the object (`"robot_jobs"`).
example: robot_jobs
attributes:
type: object
description: The attributes associated with the resource.
properties:
app_version:
type: integer
description: The version of the script.
example: 1
completed_at:
type: string
description: The date the task run was completed.
example: '2019-03-21T20:22:48.282Z'
count:
type: integer
description: The folder name that is automatically created in the Robots Agent. The folder corresponds to an individual task run.
example: 1
delete_failed:
type: boolean
description: If a user made a request to delete a task run, this indicates whether the deletion failed.
example: false
discarded_at:
type: string
description: If a user made a request to delete a task run, this is the time the user made the request.
example: null
environment:
type: string
description: The environment of the script.
enum:
- production
- development
error_code:
type: string
description: If the task run failed due to a known reason, this error code indicates that reason. Not all failed task runs have associated error codes.
example: null
queued_at:
type: string
description: The date the task run was queued to execute.
example: '2019-03-21T20:22:48.282Z'
result_analytics:
type: array
description: Includes analytics information about the task run.
items:
type: object
properties:
name:
type: string
description: The name of the script.
logs:
type: array
description: Information about the system trace logs.
items:
type: object
properties:
key:
type: string
description: The key HighBond uses to download the system trace log file.
file_name:
type: string
description: The file name for the system trace log.
success:
type: boolean
description: Indicates whether this particular script executed successfully.
example: true
result_downloadable:
type: boolean
description: Indicates whether you can download the result files in the UI.
example: true
status:
type: string
description: The status of the task run.
enum:
- success
- failed
- cancelled
- queued
- running
- skipped
trigger_type:
type: string
description: The trigger type of the task run.
enum:
- schedule
- manual
- event
agent_count:
type: string
description: For ACL Robot task runs that run with an on-premise agent, this is the ID of the agent that ran it. For all other robot types, this value is `null`.
example: null
relationships:
type: object
description: List of associated objects with the robot task run.
properties:
robot:
type: object
description: Information about the robot associated with the task run.
properties:
data:
type: object
description: Data about the robot.
properties:
id:
type: string
description: The ID of the robot.
type:
type: string
description: The classification of the object (`"robot"`).
task:
type: object
description: Information about the task associated with the task run.
properties:
data:
type: object
description: Data about the task.
properties:
id:
type: string
description: The ID of the task.
type:
type: string
description: The classification of the object (`"task"`).
triggered_by:
type: object
description: Information about the user who triggered the task run.
properties:
data:
type: object
description: Data about the user.
properties:
id:
type: string
description: The ID of the user. In addition to the user IDs used elsewhere in the HighBond API, each user also has an ID specific to Robots. To see a list of users and their Robots IDs in the response, use the `include=triggered_by` parameter.
type:
type: string
description: The classification of the object (`"user"`).
RobotsError:
type: object
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: A HTTP response status code indicating an unprocessable entity.
enum:
- '422'
example: '422'
source:
type: object
properties:
pointer:
type: string
description: Indicates the specific source of the error.
example: /data/attributes/name
title:
type: string
description: A title of the error.
example: can't be blank
detail:
type: string
description: A descriptive statement of the error.
example: Name can't be blank
Error:
type: object
required:
- status
properties:
status:
type: string
description: The HTTP status code.
source:
type: object
description: Indicates which part of the request document caused the error.
required:
- pointer
properties:
pointer:
type: string
description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity
in the request document.
'
code:
type: string
description: Application-specific error code, expressed as a string value.
title:
type: string
description: A short, human-readable summary of the problem.
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
GetRobotJobsResponse:
type: object
properties:
data:
type: array
description: The data associated with the resource.
items:
$ref: '#/components/schemas/RobotJob'
links:
type: object
properties:
prev:
type: string
description: Previous page url
next:
type: string
description: Next page url
parameters:
robotPageNumberParam:
in: query
name: page[number]
description: The page number of records to return. Default is 1.
required: false
schema:
type: string
example: 1
robotJobIdParam:
in: path
name: job_id
description: The ID of the robot job.
required: true
schema:
type: string
example: 2
robotPageSizeParam:
in: query
name: page[size]
description: The number of items returned per page. Default is 100.
required: false
schema:
type: string
example: 100
robotEnvParam:
in: query
name: env
description: The environment of an analytic script.
required: false
schema:
type: string
enum:
- development
- production
default: development
example: production
robotIdParam:
in: path
name: robot_id
description: The ID of the robot.
required: true
schema:
type: string
example: 2
robotJobsIncludeParam:
in: query
name: include
description: If specified, the associated objects will be included in the `included` list
required: false
schema:
type: string
enum:
- robot
- task
- triggered_by
example: robot,task,triggered_by
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
responses:
NotFound:
description: Not found.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: '404'
title: Not Found
detail: The requested resource does not exist.
Forbidden:
description: Forbidden.
NotJsonapiMediaType:
description: Unsupported media type.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 415
code: unsupported_media_type
title: Unsupported media type
detail: 'The endpoint supports only the application/vnd.api+json Content-Type. This request specified application/json.
'
MissingRobotId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, robot_id, is missing.
BadCredentials:
description: Bad credentials.
securitySchemes:
bearerToken:
description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a
safe and secure way to access data, while protecting your account credentials.
'
type: http
scheme: bearer
bearerFormat: oauth2
x-tagGroups:
- name: Core resources
tags:
- Robots Agents
- Robots
- Robot Tasks
- Robot Jobs
- Robot Apps
- Robot Script Versions
- Robot Activations
- Robot Files
- Robot Working Files
- Robot Collaborators
- Robots Folders Collaborators
- Robot Users
- Robots Folders
- Storyboards
- Collections
- Questionnaires
- Analyses
- Surveys
- Event Reports
- Tables
- Table columns
- Records
- Record columns
- Record statuses
- Interpretations
- Metrics
- Workflow Groups
- Results Users
- Results Triggers
- Project types
- Custom attributes
- Request item statuses
- Projects
- Projects Admin
- Planning files
- Results files
- Objectives
- Narratives
- Risks
- Controls
- Control performance schedules
- Mitigations
- Control test plans
- Control tests
- Attachments
- Walkthroughs
- Issues
- Actions
- Collaborators
- Request Items
- To-dos
- Sign-offs
- Entities
- Scheduler Filters
- Frameworks
- Handlers
- Workflows in Asset Inventory/Asset Manager
- Asset types
- Asset record types
- Attribute types
- Assets
- Asset Relationships
- Asset records
- Asset Record Relationships
- Events
- Template Toolkits
- Toolkits
- Roles
- Role Deletion
- Compliance Maps
- Time entries
- Non-project time categories
- Timesheets
- Importer
- System Users
- Organizations
- Impact Reports
- Activities
- Users
- Groups
- Scheduled Users
- Scheduled Projects
- Scheduled Hours
- Extract
- Strategy