canonical: https://jentic.com/apis/tidio.com/tidio

# Tidio API

Tidio API provides programmatic access to manage contacts, conversations, tickets, operators, departments, and project settings for the Tidio live chat platform. The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new contact, retrieve all contacts. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Create a new contact
- Retrieve all contacts
- Update multiple contacts
- Remove a contact
- Monitor Tidio API operational status and events

## Use cases

### Communications Operations

Use the Tidio API to perform communications operations programmatically. The API provides 19 endpoints covering core functionality including create a new contact, retrieve all contacts, create multiple contacts.

Example prompt: Call POST /contacts to create a new contact

### Automated Contact Properties Management

Automate contact properties operations by combining multiple Tidio API endpoints. Agents can retrieve all contacts and then create multiple contacts in a single workflow.

Example prompt: Call GET /contacts to retrieve all contacts, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Tidio API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create a new contact', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/contacts` | Create a new contact |
| GET | `/contacts` | Retrieve all contacts |
| POST | `/contacts/batch` | Create multiple contacts |
| PATCH | `/contacts/batch` | Update multiple contacts |
| GET | `/contacts/{contactId}` | Retrieve a single contact |
| PATCH | `/contacts/{contactId}` | Update contact properties |
| DELETE | `/contacts/{contactId}` | Remove a contact |
| GET | `/contacts/{contactId}/viewed-pages` | Access page history for a contact |

## Key resources

- **Contact Properties** — Operations for contact properties
- **Contacts** — Operations for contacts
- **Departments** — Operations for departments
- **Operators** — Operations for operators
- **Project** — Operations for project

## Why Jentic

- **Setup:** Wiring the Tidio API by hand means setting up its two key headers, the client id and client secret, and building the contact create, batch, and lookup calls yourself. Through Jentic you install once, import the Tidio API from the API Directory, store those keys once, and your agent calls it.
- **Permission scoping:** Tidio puts the contact id in the URL path (`/contacts/{contactId}`), so a rule can pin your agent to one contact: it can read that contact and its viewed pages and nothing else. You choose the operations it may call, so destructive ones like updating or deleting a contact are not included unless you add them.
- **Credential handling:** Your Tidio client id and client secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a new contact' or 'get a contact's viewed pages', and Jentic returns the matching Tidio API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Tidio API use?

The Tidio API uses an API key passed in the `X-Tidio-Openapi-Client-Id` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create a new contact with the Tidio API?

Yes. Use the POST /contacts endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Tidio API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create a new contact through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new contact'. Jentic returns the matching Tidio API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Tidio API have?

The Tidio API exposes 19 endpoints covering contact properties, contacts, departments operations.

### Can I limit what my agent is allowed to do with the Tidio API?

Yes. Jentic One is self-hosted, so your own rules decide which Tidio operations and credentials the agent may use. Because the contact id lives in the URL path (`/contacts/{contactId}`), you can pin the agent to a single contact and let it only read that contact and its viewed pages. You pick the operations it may call, so write actions like updating or deleting a contact stay out of reach unless you explicitly grant them.