Skip to main content

Zyles Backend API

Welcome to the reference for the Zyles backend API — the service that powers the Zyles AI sales-calling platform (CRM + telephony).

The API is a REST-style HTTP service built with actix-web. All application endpoints live under the /api prefix and expect JSON request and response bodies.

Base URL​

EnvironmentBase URL
Productionhttps://backend.zyles.ai

All paths in this reference are relative to the base URL. For example, the "Add Leads" endpoint is:

POST https://backend.zyles.ai/api/leads/add

Authentication in one line​

Every application endpoint requires a JWT in the Authorization header:

Authorization: Bearer <your_jwt_token>

The token must carry a project_id claim — all data access is scoped to that project. See Authentication for details.

How this reference is organised​

  • Getting Started — authentication, request/response conventions, and error handling.
  • API Reference — endpoints grouped by resource (Leads, Jobs, Calls, …).
About the auto-generated Swagger spec

The backend also exposes an auto-generated OpenAPI spec at /swagger-ui/. Only a small number of endpoints are currently annotated there, so it is incomplete — this hand-written reference is the source of truth. As the Rust handlers gain #[utoipa::path] annotations, the Swagger spec will catch up.