## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt)

Use this file to discover all available pages before exploring further.

The Cognigy.AI API follows a [RESTful](https://en.wikipedia.org/wiki/REST) 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](https://fetch.spec.whatwg.org/). 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](https://docs.cognigy.com/ai/administer/user-menu/my-profile#api-keys) 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](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4) 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](https://docs.cognigy.com/api-reference/management-ui/create-an-api-key).

### Error Handling

The API uses standard HTTP status codes (400 and higher) to indicate errors. Error responses follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) and include a traceId that you can provide to [Cognigy technical support](https://docs.cognigy.com/help/get-help) 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](https://docs.cognigy.com/ai/for-developers/developers/api-and-cli#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.

Last modified on July 2, 2026.