> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/human-access/open-api-and-mcp/introduction.md).

# Introduction

Learn what the Cakewalk Open API covers, its base URL and the API key headers required on every request.

Welcome to the Cakewalk API! This guide provides developers and integrators with everything they need to understand and use the API effectively.

***

### Overview

The Cakewalk API can be used to programmatically access and take action on data within Cakewalk.

Use the API to:

* Retrieve SaaS application and user data
* Automate tasks
* Integrate Cakewalk events into your operational tools
* Trigger workflows based on access or provisioning events

{% hint style="info" %}
Non-human identities are available in the Cakewalk dashboard. They are not included in this public Open API documentation.
{% endhint %}

### Base URL

```
https://open-api.getcakewalk.io/api
```

### Authentication

All endpoints require an API key and API secret for authentication. Include it as a `X-API-KEY` and `X-API-SECRET` in the `Authorization` header.

```http
X-API-KEY: api key
X-API-SECRET: api secret
```

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.cakewalk.security/docs/human-access/open-api-and-mcp/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
