For AI agents & automation

Give your agents a reliable map of ZipQuantum.

Use machine-readable documentation, the OpenAPI description, and focused API guides to help coding agents inspect, explain, and automate Smart Link workflows.

Agent-ready resources

Start with the smallest source that answers the task, then follow the canonical documentation links for implementation details.

Schema

OpenAPI

A structured API description agents can inspect when generating requests, clients, or integration examples.

View openapi.yaml ↗

Guidance

API reference

Human-readable authentication, request, response, error, parameter, and rate-limit guidance.

Browse the API reference →

A practical agent workflow

Discover the documentation

Fetch https://zq.tn/llms.txt and identify the most relevant canonical page for the task.

Inspect the contract

Use the OpenAPI description for endpoint structure, then confirm authentication and constraints in the API reference.

Generate a reviewable implementation

Keep credentials server-side, show the proposed request, and let a human approve production-changing actions.

Read https://zq.tn/llms.txt first.
Use only the canonical ZipQuantum documentation it links to.
Explain the request before executing it.
Never expose an API key in browser or mobile-app code.
Ask for approval before creating, changing, or deleting production links.

Safe defaults for agents

These rules apply whether the agent writes code, prepares a request, or assists an operator.

Keep secrets server-side

Never place a ZipQuantum API key in public JavaScript, URLs, logs, or a distributed mobile binary.

Treat link data as public

Do not put passwords, tokens, private user data, or other secrets in destinations or parameters.

Use verified domains

Only configure custom domains owned and verified by the authenticated ZipQuantum account.

Preserve human control

Require explicit confirmation before an agent performs an action that changes production data.

Start with the canonical index.

Point your coding agent to zq.tn/llms.txt, then use the API reference for the exact implementation details.

Open llms.txt ↗