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

# API Reference

> The overview of the Matrices API.

The Matrices API comes in two halves: a **control plane** and a **data plane**.

The control plane is where you set things up: agent profiles, agents, roles,
toolsets, and the model catalog. Roles hold the allow and deny rules for tools;
a profile holds behavior, hooks, and the roles it picks.

The data plane is where agents run: creating threads, messages and their queue,
memory, feeds and subscriptions, events, client tool calls, and resolving waits.

For how those resources own each other, read
[How it fits together](/model/how-it-fits-together).

## Authentication and base URL

Every endpoint takes the same organization-scoped API key as a bearer token,
and every request goes to `https://api.matrices.com`. To see what a key is, call
`GET /v1/auth`. It returns the `principal` the key acts as and the workspace it
belongs to. The playground on each endpoint page sends real requests.

A `principal.type` of `api_key` reaches every agent in the workspace. An `agent`
key carries an `agentId` and can only operate that one agent, so if you have to
put a key somewhere you wouldn't trust with the whole workspace, use an `agent`
key.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.