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

# Use Hobbes with AI agents

> Install the Hobbes API skill so coding agents can read data and make guarded Playbook updates.

The Hobbes API skill gives AI coding agents reviewed instructions for reading
Hobbes data, updating the Playbook in staging, and publishing an explicitly
approved agent version. It includes the endpoint map, scope requirements,
pagination rules, preview safeguards, and publishing confirmation boundary.

<Card title="View the Hobbes API skill" href="/.well-known/agent-skills/hobbes-read-api/SKILL.md">
  Review the complete agent instructions before installing the skill.
</Card>

## Install the skill

Use a client that supports the open Agent Skills format:

```bash theme={null}
npx skills add https://docs.hihobbes.com --list
npx skills add https://docs.hihobbes.com
```

The listing shows `hobbes-read-api`. The package keeps this existing identifier
for compatibility with earlier installations. If it still shows the older
`hobbes` entry immediately after a documentation deployment, wait for
Mintlify's skill discovery cache to refresh before installing it.

The hosted skill and its discovery metadata stay synchronized with this
documentation.

## Provide credentials safely

Create a minimum-scope key in Hobbes Settings, then provide it to the agent's
server-side environment:

```bash theme={null}
read -s HOBBES_API_KEY
export HOBBES_API_KEY
```

Do not paste a key into an agent conversation, commit it to a repository, or
place it in browser code. Remove it from the shell when the task is complete:

```bash theme={null}
unset HOBBES_API_KEY
```

## Example requests

Ask an agent to use the installed skill for tasks such as:

* "Use the Hobbes Read API to incrementally sync qualified sessions into our CRM."
* "Export the last seven days of Hobbes sessions to newline-delimited JSON."
* "Find recently active high-intent prospects and rank them by `lastSeenAt`."
* "Retrieve one selected session transcript and preserve request IDs on errors."
* "Preview a change to our Playbook opening and show me the summary before applying it."
* "After I approve the exact staged version, publish it and report whether the tests passed."

The skill tells the agent how to build or review the integration. It does not
contain an API key, grant access to an organization, or bypass the confirmation
required before a Playbook change or production publish.

## Machine-readable resources

* [Agent skill](/.well-known/agent-skills/hobbes-read-api/SKILL.md)
* [Documentation index](/llms.txt)
* [Complete documentation context](/llms-full.txt)
* [OpenAPI specification](/api-reference/openapi.json)

Use the OpenAPI specification as the field-level contract. The skill provides
the workflow and safety rules that an API schema alone cannot express.


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