Live

Quickly API

Integrate Quickly's automation capabilities into your applications. Trigger playbooks, manage agents, and query logs programmatically.

Get API Key OpenAPI JSON View Endpoints

MCP Server

Connect AI clients to Quickly tools

Use Quickly from Claude, Codex, Cursor, and other MCP-compatible clients through the hosted Streamable HTTP server.

Agent Discovery

AI-readable docs map

`llms.txt`, `llms-full.txt`, and OpenAPI documents help AI agents find the API, MCP endpoint, docs, and safety model.

Getting Started

1. Create an API key

Go to Dashboard > Settings > API Keys and generate a new key. All keys start with the qk_ prefix.

2. Authenticate requests

Include your API key as a Bearer token in the Authorization header.

3. Base URL

All endpoints are relative to:

https://app.askquickly.ai/api/v1

curl -H "Authorization: Bearer qk_your_api_key" \
  https://app.askquickly.ai/api/v1/playbooks

Authentication

The Quickly API uses Bearer token authentication. Each API key is scoped to a workspace and can be granted specific permissions.

Scopes

Scope	Description
`playbooks:read`	List and view playbooks
`playbooks:write`	Create and update playbooks
`playbooks:execute`	Trigger playbook runs
`agents:read`	List and view agents
`agents:write`	Create agents and assign playbooks
`logs:read`	View tasks and execution logs

Rate Limits

Request limits

Method	Limit
GET	100 requests/minute
POST / PUT / DELETE	20 requests/minute
Execute (trigger)	20 requests/minute

Response headers

X-RateLimit-Limit

Maximum requests allowed per window

X-RateLimit-Remaining

Requests remaining in current window

X-RateLimit-Reset

Unix timestamp when the window resets

Endpoints

Core endpoints across agents, playbooks, logs, and tools. See the OpenAPI document for the broader v1 surface.

Playbooks

Create, list, trigger, and monitor playbook executions.

GET/api/v1/playbooks

List all playbooks in your workspace.

Scope: playbooks:read

curl -H "Authorization: Bearer qk_..." \
  https://app.askquickly.ai/api/v1/playbooks

POST/api/v1/playbooks

Create a new playbook.

Scope: playbooks:write

curl -X POST -H "Authorization: Bearer qk_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"Maintenance Triage","description":"Auto-triage maintenance requests"}' \
  https://app.askquickly.ai/api/v1/playbooks

GET/api/v1/playbooks/:id

Get details for a specific playbook, including its steps and configuration.

Scope: playbooks:read

POST/api/v1/playbooks/:id/trigger

Trigger a playbook run. Pass triggerData for context and set async to true for non-blocking execution.

Scope: playbooks:execute

curl -X POST -H "Authorization: Bearer qk_..." \
  -H "Content-Type: application/json" \
  -d '{"triggerData":{"message":"New maintenance request from Unit 1405"},"async":true}' \
  https://app.askquickly.ai/api/v1/playbooks/PLAYBOOK_ID/trigger

GET/api/v1/playbooks/:id/runs

List all runs for a specific playbook, including status and timestamps.

Scope: logs:read

GET/api/v1/playbooks/:id/runs/:runId

Get full details for a specific playbook run, including step results and outputs.

Scope: logs:read

Agents

Manage agents and their playbook assignments.

GET/api/v1/agents

List all agents in your workspace.

Scope: agents:read

POST/api/v1/agents

Create a new agent with a name, description, and configuration.

Scope: agents:write

GET/api/v1/agents/:id

Get details for a specific agent, including its assigned playbooks.

Scope: agents:read

GET/api/v1/agents/:id/playbooks

List all playbooks assigned to an agent.

Scope: agents:read

POST/api/v1/agents/:id/playbooks

Assign a playbook to an agent.

Scope: agents:write

Logs

Query task history and execution details.

GET/api/v1/logs

List tasks and execution logs. Supports filtering by date, status, and playbook.

Scope: logs:read

GET/api/v1/logs/:taskId

Get full details for a specific task, including tool calls and results.

Scope: logs:read

Tools

Discover available tools for playbook configuration.

GET/api/v1/tools

List all available tools that can be used in playbooks and agent actions.

Scope: playbooks:read

Response Format

All responses follow a consistent envelope format with a data field for successful requests and an error field for failures.

Success

{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123"
  }
}

Error

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Playbook not found"
  }
}

Use Cases

CI/CD Pipelines

Trigger playbooks from your deployment workflow to run post-deploy checks.

Custom Dashboards

Pull task and playbook data into your own reporting and analytics tools.

Internal Tools

Embed Quickly automations into your existing internal applications.

Agent Management

Programmatically create and configure agents across multiple workspaces.

Ready to integrate?

Get your API key and start building with Quickly today.

Get API Key