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

# Cayzu API

Jentic publishes the only available OpenAPI specification for Cayzu API, keeping it validated and agent-ready. Cayzu is a help desk and support ticketing platform with REST endpoints for managing customers, contacts, support tickets, and knowledge base articles. Agents can list unresolved tickets, post replies, create customer or contact records, and retrieve knowledge base content to power deflection and self-service assistants. The spec covers the core help desk workflow rather than admin-level account configuration.

## For AI agents

Manage Cayzu help desk tickets, customers, contacts, and knowledge base entries. Reply to unresolved tickets and feed knowledge base content into support assistants.

## Scope

Does not handle phone calls, live chat sessions, or billing for the help desk itself - use for support ticket management and knowledge base retrieval only.

## Capabilities

- Reply to unresolved support tickets via the support_ticket reply endpoint
- List a help desk agent's unresolved tickets in one call
- Create customer accounts that group support tickets and contacts
- Register individual contacts against existing customers
- Retrieve knowledge base articles to power self-service responses
- Pull customer lists for support handoff or escalation routing

## Use cases

### Unresolved Ticket Triage

Support managers use agents to read every unresolved ticket assigned to a queue and either suggest a reply or escalate. The agent calls the unresolved tickets endpoint, evaluates each ticket against knowledge base content, and posts replies to tickets where a confident answer exists. This shortens first response time on repetitive questions.

Example prompt: Call GET `/Support_Ticket/MyUnresolved`, then for each ticket post a draft reply via POST `/support_ticket/{ticketId}/reply` using a knowledge base match

### Customer Onboarding Sync

When a new customer signs up in another system, an agent creates the corresponding record in Cayzu so support tickets attach to the right account. Individual contacts under the customer are added in the same flow. This keeps the help desk roster aligned with the source-of-truth CRM without bespoke integration work.

Example prompt: POST a new customer to /Customer, then POST the primary contact to /Individual with the returned customer id

### Knowledge Base Powered Self-Service

An assistant fronting the help centre answers user questions by pulling Cayzu knowledge base items and grounding replies in those articles. The agent retrieves the article list and feeds the relevant entries into its prompt before responding. Cited replies reduce ticket volume and give support managers a path from ad-hoc answers to documented articles.

Example prompt: Call GET `/Kb_Item/Get` and use the returned articles to answer the user's question with citations

### AI Agent Integration via Jentic

Through Jentic, an AI support agent searches by intent, loads schemas for the Cayzu ticket and reply endpoints, and executes calls without holding the API key directly. This keeps support credentials out of agent context and lets a single assistant cover both Cayzu and CRM systems.

Example prompt: Use Jentic to search 'reply to a Cayzu support ticket', load the schema, and post the resolution to `/support_ticket/{ticketId}/reply`

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/Support_Ticket/MyUnresolved` | List unresolved tickets |
| POST | `/support_ticket/{ticketId}/reply` | Reply to a ticket |
| POST | `/Customer` | Create a customer |
| GET | `/Customer/Get` | List customers |
| POST | `/Individual` | Create a contact |
| GET | `/Kb_Item/Get` | List knowledge base items |

## Key resources

- **Customer** — Create and list customer accounts that group tickets and contacts
- **Support_Ticket** — Read unresolved tickets and post replies to existing tickets
- **Individual** — Create and list individual contacts under customers
- **Kb_Item** — Retrieve knowledge base articles for self-service responses

## Why Jentic

- **Setup:** Wiring Cayzu by hand means handling its API key auth and mapping intents onto its ticket, customer, and knowledge base endpoints yourself. Through Jentic you install once, import Cayzu from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Cayzu puts the ticket id in the URL path for operations like `/support_ticket/{ticketId}/reply`, so a rule can pin your agent to replying on a specific ticket. You choose the operations it may call, so creating customers or contacts is not included unless you add it.
- **Credential handling:** Your Cayzu API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'reply to a help desk ticket' or 'look up a knowledge base article', and Jentic returns the matching Cayzu operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Zendesk Support API** — Mature help desk platform with deeper ticket, automation, and reporting endpoints
- **Freshdesk API** — Help desk with ticket, contact, and knowledge base APIs at SMB pricing
- **Slack API** — Notify support teams in Slack when an unresolved Cayzu ticket lands

## FAQ

### Why is there no official OpenAPI spec for Cayzu API?

Cayzu does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cayzu API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Cayzu API use?

The spec does not declare a security scheme; in practice Cayzu issues an API key via the help desk admin panel and expects it on each request. Through Jentic the key is stored in the encrypted vault and the agent never sees it directly.

### Can I reply to a Cayzu ticket from an AI agent?

Yes. POST `/support_ticket/{ticketId}/reply` accepts a reply body and posts it as the next response on the ticket. Combine it with GET `/Support_Ticket/MyUnresolved` to fetch the queue first.

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

The OpenAPI spec does not document rate limits and Cayzu does not publish a public limit policy. Treat it as a low-throughput help desk API and back off on 429 responses; raise concerns with Cayzu support if you need bulk access.

### How do I pull knowledge base content through Jentic?

Search Jentic for 'list Cayzu knowledge base items', load the schema for GET `/Kb_Item/Get`, and execute. The returned articles can be fed straight into a retrieval-augmented support assistant.

### Is the Cayzu API free?

API access is included with paid Cayzu help desk plans rather than sold separately. Pricing tiers are listed on cayzu.com - there is no public free tier for the API itself.

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

Yes. Because you run Jentic One yourself, your own rules decide which Cayzu operations and credentials the agent may use, so you can allow only GET `/Support_Ticket/MyUnresolved` and POST `/support_ticket/{ticketId}/reply` while leaving out customer and contact creation. Since Cayzu puts the ticket id in the URL path for the reply operation, a rule can even pin the agent to replying on a specific ticket. Any operation you do not grant, such as POST /Customer or POST /Individual, stays off limits to the agent.