API Reference

Intro to the Kognitos REST API

This guide will help you get started with the Kognitos REST API.

Overview

The Kognitos REST API enables you to integrate with our platform programmatically.

API Information

Base URLs

Our API is available in two regions: the United States (US) and Europe (EU). Depending on where your data is hosted or which region you want to target, you will use one of the following base URLs:

US Region: https://rest-api.app.kognitos.com

EU Region: https://rest-api.eu.kognitos.com

Authentication

An API key is required for access. To obtain an API key, please reach out to support at [email protected] or through our Support AI Chat (preferred).

Request Headers

The API key should be included in the request headers as follows:

x-api-key="the api key given to you by Kognitos"

Example Requests

Start a New Automation Run

curl -X POST "<https://rest-api.app.kognitos.com/v1/invoke/{share_id}>" -H "x-api-key: your_api_key" -H "Content-Type: application/json" -d '{"body": {"parameter1": "value1"}}'

Get Status of an Automation Run

curl -X GET "<https://rest-api.app.kognitos.com/v1/run/{worker_id}>" -H "x-api-key: your_api_key"