Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Andr21Da16/Quikko/llms.txt

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

Quikko includes two system-level endpoints outside the /api/v1 namespace: a health check for infrastructure probes and a documentation UI for exploring the API interactively. Neither endpoint requires authentication.

​
GET /health

GET /health Readiness probe endpoint. Returns a simple {"status": "ok"} JSON object with HTTP 200 when the server is running and able to accept requests.
This endpoint does not use the standard Quikko response envelope. It returns plain JSON — not {"success": true, "data": {...}} — to remain compatible with health-check tools that expect a minimal payload.

​
Response — 200 OK

{"status": "ok"}

​
Usage

Kubernetes

Use as a readinessProbe or livenessProbe in your Pod spec to gate traffic until the server is fully started.

Load Balancer

Configure your load balancer or reverse proxy to poll /health and remove the instance from rotation if it returns a non-200 status.

Uptime Monitoring

Point any uptime-monitoring service (UptimeRobot, Better Uptime, Checkly) at /health for lightweight availability checks.
curl http://localhost:8080/health
# {"status":"ok"}

​
GET /docs

GET /docs Serves the Swagger UI — an interactive API explorer loaded from CDN assets. Use it to browse every endpoint, read request/response schemas, and execute requests directly from your browser without writing any code.
The live Swagger UI for the Quikko production instance is available at https://quikko-production.up.railway.app/docs.
Local development: http://localhost:8080/docs Production: https://<your-domain>/docs

​
GET /docs/openapi.yaml

GET /docs/openapi.yaml Serves the raw OpenAPI 3.0 YAML specification file. Use this URL to:
  • Generate client SDKs with tools like openapi-generator or oapi-codegen
  • Import into Postman — use Import → Link and paste the URL
  • Import into Insomnia — use Import → From URL
  • Validate your integration against the authoritative schema
# Download the OpenAPI spec
curl -O http://localhost:8080/docs/openapi.yaml

# Or pipe it directly into a code generator
curl -s http://localhost:8080/docs/openapi.yaml | openapi-generator-cli generate \
  -i /dev/stdin \
  -g typescript-fetch \
  -o ./generated-client

Build docs developers (and LLMs) love

Get started for freeTalk to us