# Collate Topics API

**Canonical:** https://apis.io/apis/collate/collate-topics-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 Topics 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 Topic. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `Topic` is a feed or an event stream in a `Messaging Service` into which publishers publish messages and consumed by consumers.

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/topics/{id}/followers` | Add a follower |
| GET | `/v1/topics/{id}/sampleData` | Get sample data |
| PUT | `/v1/topics/{id}/sampleData` | Add sample data |
| DELETE | `/v1/topics/{id}/sampleData` | Delete sample data |
| PUT | `/v1/topics/bulk` | Bulk create or update topics |
| GET | `/v1/topics` | List topics |
| PUT | `/v1/topics` | Update topic |
| POST | `/v1/topics` | Create a topic |
| GET | `/v1/topics/name/{fqn}` | Get a topic by fully qualified name |
| DELETE | `/v1/topics/name/{fqn}` | Delete a topic by fully qualified name |
| PATCH | `/v1/topics/name/{fqn}` | Update a topic using name |
| GET | `/v1/topics/{id}` | Get a topic by id |
| DELETE | `/v1/topics/{id}` | Delete a topic by id |
| PATCH | `/v1/topics/{id}` | Update a topic |
| DELETE | `/v1/topics/async/{id}` | Asynchronously delete a topic by id |
| DELETE | `/v1/topics/{id}/followers/{userId}` | Remove a follower |
| DELETE | `/v1/topics/deleteStale` | Delete stale topics within a scope |
| GET | `/v1/topics/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/topics/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/topics/{id}/versions/{version}` | Get a version of the topic |
| GET | `/v1/topics/history` | List all entity versions within a time range |
| GET | `/v1/topics/{id}/versions` | List topic versions |
| PUT | `/v1/topics/restore` | Restore a soft deleted topic |
| PUT | `/v1/topics/{id}/vote` | Update Vote for a Entity |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-topics-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

Topic

---

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