About Cognigy.AI API

Introduction to the Cognigy.AI REST API, covering authentication, CORS support, and RESTful endpoints for managing AI Agents and platform resources.

The Cognigy.AI API follows a RESTful design and uses standard HTTP methods, status codes, and authentication mechanisms. All endpoints support JSON-encoded responses and predictable resource-oriented URLs.

Cross-Origin Resource Sharing (CORS)

The API fully supports CORS in accordance with the W3C specification. All responses include a wildcard Access-Control-Allow-Origin header, enabling cross-domain browser requests.

Authentication

Cognigy.AI supports the following authentication methods:

API Key

For Cognigy installations, use an API key in the request path or HTTP headers. Keep it secure and revoke it if exposed.

OAuth2

Use OAuth2 authentication to get an access token via the standard OAuth2 Client Credentials flow. Provide the access token in the Authorization header as a Bearer token.

BasicAuth

Use a username and password for API requests related to the Management UI.

Error Handling

The API uses standard HTTP status codes (400 and higher) to indicate errors. Error responses follow RFC 7807 and include a traceId that you can provide to Cognigy technical support for troubleshooting.

API Server

Cognigy.AI API:

• Core Resources: https://api-trial.cognigy.ai/new/
• Simulator: https://api-trial.cognigy.ai/testing/

For constructing the API base URL for your environment, refer to API Base URL.

API Scope

The Cognigy.AI API is split into two independently versioned services:

API	Base Path	Purpose
Core Resources	/new/	Manages the lifecycle of AI Agents, including Flows, Endpoints, Snapshots, Knowledge Stores, and platform administration.
Simulator	/testing/	Manages automated testing resources such as scenarios, simulation runs, schedules, and evaluation results.

Both services share the same authentication methods and error-handling conventions described above.