# API introduction

Integrate with the Zild API using the current OpenAPI contract, API key authentication, and complete request and response examples.

Source: https://zild.ai/en-US/docs/api-reference/introduction

## Contract overview

This page is generated from OpenAPI vv1. The specification is the source of truth for paths, fields, required values, and response contracts.



<table class="api-params"><thead><tr><th>Item</th><th>Value</th></tr></thead><tbody><tr><td>OpenAPI</td><td><code>3.0.4</code></td></tr><tr><td>API version</td><td><code>v1</code></td></tr><tr><td>Operations</td><td>124</td></tr><tr><td>Paths</td><td>72</td></tr><tr><td>Schemas</td><td>102</td></tr></tbody></table>

[Download the OpenAPI specification](/openapi.json)

## Base URL



```
https://api.zild.ai
```

Endpoint paths are relative to this origin and preserve the exact casing and segments defined by OpenAPI.

## Authentication

Send your user API key in the X-API-Key header.



```
X-API-Key: YOUR_USER_API_KEY
```

Keep the key out of browser code, repositories, logs, and shared materials. Tenant scope and effective permissions are the same as those of the user who generated the key.

## Request formats

- Use `application/json` for JSON endpoints.
- Use `multipart/form-data` when an operation combines files and fields.
- Dates use `date` and `date-time` as indicated by each schema.
- Query parameters are optional unless the Required column says Yes.

## API areas



<table class="api-params"><thead><tr><th>Area</th><th>Operations</th></tr></thead><tbody><tr><td>CRM</td><td>11</td></tr><tr><td>Agents</td><td>40</td></tr><tr><td>Voice</td><td>8</td></tr><tr><td>Insight</td><td>12</td></tr><tr><td>Assist</td><td>8</td></tr><tr><td>Conversations</td><td>9</td></tr><tr><td>Documents</td><td>6</td></tr><tr><td>Flow</td><td>24</td></tr><tr><td>Subscription consumption</td><td>1</td></tr><tr><td>Webhooks</td><td>5</td></tr></tbody></table>



## How to read the reference

Each operation documents parameters, content type, body fields, a cURL example, response codes, a response example, and every model reachable from the contract. Fields not marked required in OpenAPI appear as optional; nullable values, enums, limits, and defaults are shown separately.