Home›REST API›Tools and downloads

Tools and downloads

Download the OpenAPI specification and machine-readable index for the Interact REST API.

Machine-readable resources for the Interact REST API — import them into your tools, or point an AI assistant at them.

OpenAPI specification

The OpenAPI specification describes every endpoint in the API reference — paths, parameters, request bodies and response schemas — in a single JSON file.

Import it into an API client to get a ready-made request collection:

  • Postman — Import > File, then select the downloaded JSON. Postman builds a collection from the spec.
  • Insomnia — Create > Import From File.
  • Code generation — tools such as OpenAPI Generator can produce client libraries in most languages from this file.

Note: The specification lists your-intranet-api-domain as a placeholder host. Set it to your intranet's API domain, and configure the X-Tenant header and an Authorization: Bearer token — see the Quickstart.

Index for AI tools

The llms.txt file is a plain-text index of every page in this portal, formatted in Markdown. Point an AI assistant or coding agent at it to give it a map of the documentation and links to each page.

Section: REST API