# Collate Personas API

**Canonical:** https://apis.io/apis/collate/collate-personas-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Personas API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Personas. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `Persona` is to represent job function a user does. OpenMetadata uses Persona to define customizable experience in the UI.

## Operations (25)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/personas` | List personas |
| PUT | `/v1/personas` | Update Persona |
| POST | `/v1/personas` | Create a Persona |
| POST | `/v1/personas/{id}/aiContext/rules` | Create a persona AI context rule |
| GET | `/v1/personas/name/{name}` | Get a Persona by name |
| DELETE | `/v1/personas/name/{name}` | Delete a Persona by name |
| GET | `/v1/personas/{id}` | Get a persona by id |
| DELETE | `/v1/personas/{id}` | Delete a Persona by id |
| PATCH | `/v1/personas/{id}` | Update a Persona |
| PUT | `/v1/personas/{id}/aiContext/rules/{ruleId}` | Update a persona AI context rule |
| DELETE | `/v1/personas/{id}/aiContext/rules/{ruleId}` | Delete a persona AI context rule |
| DELETE | `/v1/personas/async/{id}` | Asynchronously delete a Persona by id |
| GET | `/v1/personas/{id}/context` | Get the materialized AI context for a persona by id |
| GET | `/v1/personas/name/{fqn}/context` | Get the materialized AI context for a persona by name |
| GET | `/v1/personas/{id}/aiContext` | Get a persona AI context configuration |
| PUT | `/v1/personas/{id}/aiContext` | Update persona AI context settings |
| GET | `/v1/personas/{id}/aiContext/document` | Get the compiled persona AI context document |
| GET | `/v1/personas/me/context` | Get the materialized AI context for the caller's active persona |
| GET | `/v1/personas/{id}/versions/{version}` | Get a version of the Persona |
| GET | `/v1/personas/history` | List all entity versions within a time range |
| GET | `/v1/personas/{id}/versions` | List Persona versions |
| PATCH | `/v1/personas/name/{fqn}` | Update a Persona using name |
| POST | `/v1/personas/{id}/aiContext/rules/preview` | Preview the entities matched by a persona AI context rule |
| POST | `/v1/personas/{id}/aiContext/document:refresh` | Force recompilation of a persona AI context document |
| GET | `/v1/personas/search` | Search personas |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-personas-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Personas

---

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