About

Invoke

Invoke automation runs.

v1 of the REST API is now deprecated. Please refer to v2 for the latest endpoints and features.

Start a new automation run

post

Asynchronously starts an automation run given a share_id.

To get the share_id:

  1. Go to Processes and click on a Process to open the Process view.
  2. In the process view, navigate to the three dots in the top-right corner. Click to open the drop-down menu.
  3. Select Copy API Endpoint. It will copy the endpoint URL with the alpha-numeric share_id at the end. For example:
    • The endpoint URL: https://rest-api-main.kognitos-test.net/v1/invoke/abcd3fg9ijk5mn1pqr3tu2wxy
    • The share_id: abcd3fg9ijk5mn1pqr3tu2wxy
Authorizations
Path parameters
share_idstringRequired

The share_id identifies the automation to start. The share_id can be obtained from within the Kognitos web app when looking at an automation. Note that a share_id identifies an automation and a stage - draft/published.

Query parameters
attachments_keystringOptional

The (optional) key to use for passing a list of file attachments to the run. For example, if attachments_key is "attachments", then the client can pass the list of attachments using the parameter "attachments" in the body of the request. The value should be a list of blob_uris. See the upload API for more detail on how to get a blob_uri.

Body
objectOptional
Responses
201
Successful operation
application/json
post
POST /v1/invoke/{share_id} HTTP/1.1
Host: rest-api.app.kognitos.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "fred"
}
{
  "worker_id": "6moof09dp5yjlpdunoth3m80s"
}

Last updated

Was this helpful?