> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cortex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API operations

> Programmatic access to your entities, Scorecards, Workflows, and more

## Cortex API

The Cortex REST API provides programmatic access to your entities, Scorecards, Workflows, and more.

### Base URL

Send API requests to the base URL for the region or deployment where your Cortex workspace is hosted:

| Deployment | Base URL |
| - | - |
| US | `https://api.getcortexapp.com` |
| EU | `https://api.eu.cortex.io` |
| Self-managed | Your Cortex backend URL (for example, `https://cortex-api.yourdomain.example`) |

If you're not sure which region your workspace is in, check the URL you use to log in. If it starts with `app.eu.cortex.io`, use the EU base URL. If it starts with `app.getcortexapp.com`, use the US base URL.

For self-managed Cortex, use the hostname you set as `app.hostnames.backend` in your Helm chart values.

### Authentication

All requests to the Cortex API need to provide an `Authorization: Bearer <token>` header, where `<token>` is an API key created in the Settings page of your workspace.

| Security Scheme Type: | http |
| - | - |
| HTTP Authorization Scheme | bearer |
| Bearer format: | JWT |

### Operations

See the sub-pages in this section for all available operations. Throughout these documentation pages, click **Try it** under an operation to send a request directly from the documentation page. Before you send it, click the base URL next to the endpoint path and select the one that matches your workspace. For self-managed Cortex, select `{baseUrl}`, then enter your backend URL in the **baseUrl** field under **Server**.

![The selector icon in the base URL.](https://mintcdn.com/cortex-290c0c42/KuOyXNHfLFf7MXsJ/images/api-selector.png?fit=max\&auto=format\&n=KuOyXNHfLFf7MXsJ\&q=85\&s=21e5efd6e3dd652c456784fd62327c9b)

![A list of the available base URLs for the API.](https://mintcdn.com/cortex-290c0c42/KuOyXNHfLFf7MXsJ/images/api-selector-urls.png?fit=max\&auto=format\&n=KuOyXNHfLFf7MXsJ\&q=85\&s=761f59ea067e2052b6b169723da61e40)

### Rate limiting

The Cortex API limits requests to 1000 per minute per client. The body size of any given request has a maximum of 2MB.
If you attempt too many requests in a short period, a `429` error will be returned with a `Retry-After` header. If you are hitting rate limits frequently, please contact your Cortex Customer Success Manager to discuss your use case.

> [!NOTE]
>
> API rate limits are subject to change. Customers will be notified of any changes made to the rate limits.


## Related topics

- [List API keys](https://docs.cortex.io/api/rest/api-keys/list-api-keys.md)
- [Create API key](https://docs.cortex.io/api/rest/api-keys/create-api-key.md)
- [Get API key](https://docs.cortex.io/api/rest/api-keys/get-api-key.md)
