Skip to main content

​
Welcome

The Zild API enables integration with Zild products such as messaging agents, voice automation, insights, and workflow orchestration.

​
Authentication

Zild API endpoints support two authentication methods:

​
OAuth 2.0 Bearer Token

If you are using the OAuth authentication flow, include the access token in the Authorization header: Authorization: Bearer YOUR_ACCESS_TOKEN This method is recommended for integrations requiring delegated user access.

​
X-API-Key Header

Alternatively, you can authenticate using your personal API key: X-API-Key: YOUR_API_KEY This method is suitable for server-to-server integrations.

​
How to Retrieve Your API Key

To obtain your API Key:
  1. Log into your Zild account.
  2. Click on your initials or profile picture in the top-right menu.
  3. Select Profile.
  4. Your API Key will be displayed in the Profile section.
Each API Key is tied to a specific user.