Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getquikly.com/llms.txt

Use this file to discover all available pages before exploring further.

Quikly’s REST API is available on three tiers. Picking the right one up front avoids key suspensions and unexpected throttling when you scale.

​
Quick chooser

Self-serve

For your own integrations: scripts, internal tools, n8n workflows you build for yourself or for clients as part of your professional service. Included in every plan.

Business (API Boost)

For higher-volume self-serve use cases — the same integrations as above, but you need more than 2,000–5,000 calls/month. Add-on on top of your existing plan.

Partner

For embedding Quikly in a product you sell to third-party end-users. Requires a separate agreement. Contact us.

​
Self-serve

This is the default tier. Anyone on any paid plan (Starter, Professional, Agency, Lifetime) can generate API keys from Settings → API Keys. What it’s for:
  • n8n / Zapier / Make workflows you run for yourself.
  • CI/CD pipelines that fetch proposals or update statuses.
  • A Telegram bot or web widget you embed on your own site to capture leads for your freelance or agency business.
  • An internal dashboard your team uses alongside the Quikly UI.
Limits: see API keys → Rate limits and quota. What’s NOT allowed on self-serve:
  • Reselling Quikly functionality to third parties as if it were your own product.
  • Running a single API key on behalf of many paying customers of your product (multi-tenant proxying).
  • Stripping the attribution on generated outputs and presenting them as generated by your brand.
These cases require the Partner tier below. See the full policy in Terms of Service §5.3.

​
Business (API Boost)

Status: coming soon. If you’re hitting the self-serve ceiling today and your use case is still “your own integrations”, email us at contact@getquikly.com and we’ll whitelist extra quota while the add-on ships.
API Boost is an add-on on top of a Professional, Agency, or Lifetime plan. It raises your monthly call quota and per-minute rate limit without changing which endpoints you can reach. Use it when:
  • You have one or two heavy automations that occasionally spike past the included quota.
  • You’re running a proposal pipeline for your own clients and need more headroom than Agency’s 2,000/month.

​
Partner

The Partner tier is for companies building a product on top of Quikly that serves their own paying customers. Typical partner scenarios:
  • An AI agent builder whose users create agents that generate proposals.
  • A CRM or ops tool that embeds Quikly’s proposal and rate-recommendation flow natively.
  • A white-label service powered by Quikly.
Partner integrations get:
  • A dedicated /api/v1/partner/* namespace with higher limits.
  • A separate authentication path (API key + HMAC request signing).
  • Per-end-user cardinality built into the pricing (you’re billed for what your users consume, not on a flat monthly quota).
  • A formal Partner Agreement that covers attribution, data responsibility, anti-reverse-engineering, and termination.
Partner integrations must:
  • Send X-Partner-Id, X-External-User-Id, and X-Agent-Id on every request (see traceability headers).
  • Keep “Powered by Quikly” attribution unless the Partner Agreement explicitly waives it.
  • Isolate end-user data (no cross-tenant leakage).
How to start: email contact@getquikly.com with a short description of what you’re building, expected monthly volume, and whether you need white-label. We send a Partner Agreement draft and a sandbox API key.

​
Decision table

Your use caseRight tier
”I want to connect my Telegram bot to Quikly for my own pre-sales.”Self-serve
”I run an agency and want n8n to auto-create proposals from Typeform.”Self-serve
”My internal tool makes 5,000 rate-recommendation calls a month.”Self-serve + API Boost
”I’m building an AI agent platform and my users will create agents that call Quikly.”Partner
”I want to resell Quikly’s rate calculator under my brand.”Partner
”My SaaS has a ‘generate proposal’ button that calls Quikly in the background for all my customers.”Partner

​
Attribution and watermarking

Outputs generated by Quikly’s AI endpoints (agent chat, rate recommendation, proposal analysis, differentiators) include a source: "quikly.ai" marker in the response metadata. PDFs generated on Starter plans include a “Powered by Quikly.ai” footer; Pro/Agency/Lifetime PDFs don’t, but the JSON responses still carry attribution metadata. Removing or masking this metadata on self-serve is a breach of our Terms of Service §5.3.2. Partners can negotiate attribution rules in their agreement.