OpenAPI specification

The Topicary REST API is described by a machine-readable OpenAPI 3.1 document. Use it to generate typed client libraries, scaffold mock servers, drive contract tests, or explore the API in tools like Postman, Insomnia, and Swagger UI.

Before you begin #

Download the spec #

The specification is served as YAML at:

https://topicary.com/openapi.yaml

It is the canonical contract for the API: base URL, authentication, every endpoint, request and response schemas, and error codes. The narrative topics in this section (REST API overview, REST API authentication, and REST API endpoints) describe the same API in prose.

Browse it interactively #

For an interactive reference rendered from the same spec, including request and response schemas and an in-browser request console, open:

https://topicary.com/api-docs

Use the Authorize button there to set your REST API authentication before trying a request.

Import into API tools #

Most API tools can load the spec directly from its URL:

• Postman: Import → Link and paste the spec URL. Postman generates a collection covering every endpoint.

• Insomnia: Create → Import From → URL.

• Swagger UI / Redoc: point the viewer at the spec URL to browse interactive documentation.

When prompted for a server, use https://topicary.com/api/v1.

Generate a client #

Code generators read the spec to produce a typed SDK in your language. For example, with openapi-generator:

openapi-generator-cli generate \
  -i https://topicary.com/openapi.yaml \
  -g typescript-fetch \
  -o ./topicary-client

Set the bearer token to your REST API authentication (the tk_-prefixed value) when you configure the generated client.

See also #

• REST API overview: base URL, rate limits, response envelope, and error codes

• REST API authentication: generate and manage API keys

• REST API endpoints: full endpoint reference with examples