About

Processes

Retrieve information about your automation processes. You can retrieve details about a specific process or all processes within an agent.

List Processes

get

Get a list of processes for a specified agent_id.

Authorizations
Query parameters
agent_idstringRequired

The unique identifier of the agent. Find your agent ID by opening the Agent drop-down menu at the top of the platform, selecting View All, and locating the ID in the table.

Example: 9k2tdm8z6pwry9n4hc3vfqe27
limitany ofOptional

Maximum number of items to return.

integer · max: 100Optional
or
nullOptional
continuation_tokenany ofOptional

Pagination token used to retrieve the next page of results. It is returned in a prior response from a call made to this endpoint.

stringOptional
or
nullOptional
Responses
200
A List of processes
application/json
get
GET /v2/processes HTTP/1.1
Host: rest-api.app.kognitos.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "continuation_token": "text",
  "items": [
    {
      "field1": "...",
      "id": "<resource-id>",
      "name": "user provided name"
    }
  ]
}

Get Process

get

Get information about a specific process.

Authorizations
Path parameters
process_idstringRequired

The unique identifier of the process. This can be obtained by calling the List Processes endpoint.

Query parameters
agent_idstringRequired

The unique identifier of the agent. Find your agent ID by opening the Agent drop-down menu at the top of the platform, selecting View All, and locating the ID in the table.

Example: 9k2tdm8z6pwry9n4hc3vfqe27
Responses
200
The process specified
application/json
get
GET /v2/processes/{process_id} HTTP/1.1
Host: rest-api.app.kognitos.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "agent_id": "b4fznghynbdemslfd5k044fgd",
  "id": "b4fznghynbdemslfd5k044fgd",
  "name": "Process invoice",
  "stage": "Draft"
}

Was this helpful?