Processes

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

List Processes

get

https://rest-api.app.kognitos.com/v2https://rest-api.eu.kognitos.com/v2https://rest-api.uk.kognitos.com/v2

/processes

Get a list of processes for a specified agent_id.

Authorizations

APIKeyHeader

x-api-keystringRequired

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

continuation_tokenany ofRequired

Used in subsequent GET requests to obtain more results for the same query (pagination)

stringOptional

or

nullOptional

itemsany ofRequired

List of resources

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

or

nullOptional

400

Invalid input values

application/json

404

The specified agent was not found

application/json

get

/processes

HTTPcURLJavaScriptPython

GET /v2/processes?agent_id=text 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

https://rest-api.app.kognitos.com/v2https://rest-api.eu.kognitos.com/v2https://rest-api.uk.kognitos.com/v2

/processes/{process_id}

Get information about a specific process.

Authorizations

APIKeyHeader

x-api-keystringRequired

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

agent_idstring · min: 1 · max: 26Required

The ID of the agent

Example: b4fznghynbdemslfd5k044fgdPattern: ^[a-zA-Z0-9-_]+$

idstring · min: 1 · max: 26Required

The ID of the resource

Example: b4fznghynbdemslfd5k044fgdPattern: ^[a-zA-Z0-9-_]+$

namestring · min: 1 · max: 100Required

The name of the resource

Example: Process invoice

stagestring · enumRequired

The stage of the process

Example: DraftPossible values:

400

Invalid input values

application/json

404

The specified process or agent was not found

application/json

get

/processes/{process_id}

HTTPcURLJavaScriptPython

GET /v2/processes/{process_id}?agent_id=text 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"
}