🌩 API Reference

The OmniMind is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Getting started with our API is a fast and straightforward process. You can easily create and oversee your OmniMind, manage your content, and engage in conversations or queries with your content.

  • Most API requests require an API Key, these can be from the Settings page within your OmniMind
  • Authentication and access is managed per OmniMind, not across your entire account
  • Authentication can be done in three ways: through the request body, in the header, in the URL
  • Remember to set the header for Content-Type: application/json
  • The answers you get via API should be identical to those you would receive if you were interacting directly through the UI

We’ll give you a quick guide to our API, but you can learn more about it using Swagger


Was this article helpful to you? Yes 1 No 1

How can we help?