Guides
Breadcrumbs

Chat API (REST API)

Overview

This documentation outlines the methods for creating and managing messages, attachments, and chat sessions via our REST API. It provides a detailed overview of the available endpoints and the structure of messages sent and received through them.

Authentication

Include the following headers in your HTTP requests to authenticate:

Authorization: Bearer {{Token}}

Here’s an example command using cURL:

Bash
curl -X GET \
  -H "Authorization: Bearer {{Token}}" \
  https://example.com/api/your-endpoint

Ensure the token is included in the Authorization header for every request, to successfully authenticate and access the API endpoints.

Keep your tokens secure and never expose them in public repositories or insecure environments.

Error Codes

Omilia's HTTP response codes can be found on the HTTP Code Responses page.

API Reference

Open API Spec