> For the complete documentation index, see [llms.txt](https://intuitem.gitbook.io/ciso-assistant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intuitem.gitbook.io/ciso-assistant/product-docs/ai-and-integrations/api.md).

# API reference

CISO Assistant exposes a REST API that mirrors the platform's object model. The same API powers the web frontend, the CLI, the MCP server, and every external integration. Anything you can do in the UI, you can do over HTTP.

## Authentication

The API uses token-based authentication. To call any endpoint:

1. **Create a Personal Access Token (PAT)** from your user profile in the application.
2. **Add the token to the `Authorization` header** of every request:

   ```
   Authorization: Token <your_token>
   ```

Example with curl:

```sh
curl --request GET \
  --url https://your-instance/api/assets/ \
  --header 'Authorization: Token a6a120f...'
```

Notes:

* Always include the trailing slash on endpoints (`/api/assets/`, not `/api/assets`).
* Your endpoint URL is your instance URL with `/api/` appended (assuming default proxy settings).
* Pro SaaS users need to open a support request to expose the API on their instance — it is disabled by default.

## Browsing the schema

Two ways to read the API surface:

* **Live online docs** — [ca-api-doc.pages.dev](https://ca-api-doc.pages.dev).
* **On your instance, in debug mode** — set `DJANGO_DEBUG=True`, start the backend, then browse:
  * Swagger UI: `http://127.0.0.1:8000/api/schema/swagger/`
  * ReDoc: `http://127.0.0.1:8000/api/schema/redoc/`

## Related

* [Philosophy → Open by default, extensible by design](/ciso-assistant/product-docs/introduction/philosophy.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://intuitem.gitbook.io/ciso-assistant/product-docs/ai-and-integrations/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.