API introduction

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

Contract overview

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

Download the OpenAPI specification

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

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.