> For the complete documentation index, see [llms.txt](https://wiki.crosswatch.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference.md).

# API reference

API overview and endpoint reference, organized by functional area.

CrossWatch has a self-hosted JSON API for automation, monitoring, and integrations.

Routes are grouped by the task they support. Use an API token for scripts and services.

### Start here

{% content-ref url="/pages/nQt9U8rY0Lw488M9JZA5" %}
[API foundations](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/api-foundations.md)
{% endcontent-ref %}

Use the foundations reference to check instance health, authenticate requests, and understand response behavior.

### Browse by task

<table data-view="cards"><thead><tr><th>Reference</th><th data-card-target data-type="content-ref">Open</th></tr></thead><tbody><tr><td>Connect providers and manage provider or user profiles.</td><td><a href="https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/connections-and-instances.md">Connections and instances</a></td></tr><tr><td>Configure pairs, run synchronization, and manage schedules.</td><td><a href="https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/synchronization-and-scheduling.md">Synchronization and scheduling</a></td></tr><tr><td>Configure Watcher routes, webhooks, and playback integrations.</td><td><a href="https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/scrobbling-and-webhooks.md">Scrobbling and webhooks</a></td></tr><tr><td>Work with metadata, events, playlists, analysis, imports, and exports.</td><td><a href="https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/data-insights-and-tools.md">Data, insights, and tools</a></td></tr><tr><td>Inspect logs, manage captures and backups, and perform maintenance.</td><td><a href="https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/storage-and-operations.md">Storage and operations</a></td></tr></tbody></table>

### Safe automation

* Check both the HTTP status and response body. Some routes return `200` with `ok: false`.
* Keep API tokens, webhook URLs, and feed keys out of logs and screenshots.
* Test write operations against a non-production instance first.


---

# 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://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference.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.
