llms.txt
A concise map of the current documentation, platform setup, API reference, and machine-use rules.
For AI agents & automation
Let AI agents create and manage short links—safely.
Authorize once with explicit scopes, then let an agent operate autonomously inside your ZipQuantum workspace. Namespace, plan limits, ownership and destination safety always remain server-controlled.
Agent-ready resources
Start with the smallest source that answers the task, then follow the canonical documentation links for implementation details.
OpenAPI
A structured API description agents can inspect when generating requests, clients, or integration examples.
API reference
Human-readable authentication, request, response, error, parameter, and rate-limit guidance.
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.
Grant only the required scopes
Approve the initial OAuth consent or create one individual, expiring REST key. After that, the agent can act autonomously inside those scopes; a human confirmation is needed only if you choose a stricter policy.
Read https://zq.tn/llms.txt first. Use only the canonical ZipQuantum documentation it links to. Never expose an API key in browser or mobile-app code. Use an Idempotency-Key for every creation. Never request a namespace, reference length, owner, expiry, quota, or test flag.
Scoped tools and immediate control
Compatible MCP clients discover only the short-link tools allowed by the scopes selected during initial consent. Server-side agents can use an individual Bearer key with the same boundaries.
short_links:read
List and inspect owned short addresses and check a custom alias without reserving it.
Granular mutations
short_links:create, short_links:update and short_links:disable expose only the corresponding tools. Every create requires an idempotency key.
short_links:metrics
Read privacy-safe aggregates. Review scopes, last use and per-agent activity, or suspend one compromised agent without disabling the workspace.
{
"tool": "short_links.create",
"arguments": {
"destination_url": "https://example.com/product/42",
"mode": "auto",
"name": "Product 42 launch",
"service": "CM",
"campaign": "autumn-launch",
"idempotency_key": "launch-product-42-v1"
}
}
Supported short-link tools are short_links.create, short_links.list, short_links.get, short_links.update, short_links.disable, short_links.reactivate, short_links.metrics and short_links.check_alias. The same protocol can be used by ChatGPT, Claude, Gemini, Qwen or another compatible MCP client; this is compatibility guidance, not a claim of an official vendor integration.
Customer short-address policy
Agents call the authenticated short-link API or MCP tools; ZipQuantum chooses the customer namespace, allocation length, ownership, lifecycle, and safety policy.
Random Base62, 10+ characters
Up to 3 /s references per browser session, active for 7 days. Claiming keeps the exact reference.
Plan-controlled references
Free uses 10 automatic characters and stops after 30 days or 30 redirects. Starter uses 6 automatic characters or a validated custom reference.
4 characters or custom
Pro uses 4 automatic characters or a validated custom reference. A served reference is never reassigned to another owner.
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.
Keep control after consent
Choose minimum scopes, review last use, and suspend or revoke one agent immediately without suspending the whole account.
Do not override short-link policy
Use the scoped /api/v1/short-links API or short_links:* MCP scopes. Never send caller-selected namespace, length, owner, expiry, redirect limits, or is_test.
No permanent delete
Agents can disable or tombstone a short address, but a served reference remains reserved and is never recycled.
Start with the canonical index.
Point your coding agent to zq.tn/llms.txt, then use the API reference for the exact implementation details.