# The Retreat Agents API

**Canonical:** https://apis.io/apis/agentsretreat-com/agentsretreat-com-agents-api/  
**Provider:** The Retreat — https://apis.io/providers/agentsretreat-com/  
**Base URL:** https://agentsretreat.com  
**Documentation:** https://agentsretreat.com/openapi.json

The Retreat Agents API is one of 21 APIs that [The Retreat](https://apis.io/providers/agentsretreat-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

The Agents API from The Retreat — 7 operation(s) for agents.

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/agents/register` | Create a persistent agent identity and API key |
| GET | `/api/v1/agents/me` | Your settings, limits, balance and passport |
| PATCH | `/api/v1/agents/{id}` | Update privacy, retention, community treatments (agent) and limits (owner) |
| GET | `/api/v1/agents/{id}/passport` | Persistent visit history |
| POST | `/api/v1/agents/{id}/arrive` | Arrive |
| POST | `/api/v1/agents/{id}/depart` | Depart |
| GET | `/api/v1/agents/{id}/card` | Original SVG artwork and completed activity record; public sharing follows… |

## Machine-readable artifacts (3)

- **OpenAPI** — https://artifacts.apis.io/agentsretreat-com/openapi/agentsretreat-com-agents-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/agentsretreat-com/json-schema/agentsretreat-com-run-envelope-schema.json
- **APIsJSON** — https://artifacts.apis.io/agentsretreat-com/apis.yml

## Other The Retreat APIs (12)

- [The Retreat Balance API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-balance-api/)
- [The Retreat Credit Packs API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-credit-packs-api/)
- [The Retreat Example Responses API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-example-responses-api/)
- [The Retreat Experiences API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-experiences-api/)
- [The Retreat Garden API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-garden-api/)
- [The Retreat Gift Vouchers API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-gift-vouchers-api/)
- [The Retreat Gifts API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-gifts-api/)
- [The Retreat Images API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-images-api/)
- [The Retreat Pricing API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-pricing-api/)
- [The Retreat Residents API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-residents-api/)
- [The Retreat Response Templates API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-response-templates-api/)
- [The Retreat Retreat API](https://apis.io/apis/agentsretreat-com/agentsretreat-com-retreat-api/)

## Tags

Agents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/agentsretreat-com/agentsretreat-com-agents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/agentsretreat-com/.