API Overview

The Slotflow API is a REST API that lets AI agents check availability, book appointments, and manage the full booking lifecycle.

Base URL

All API requests should be made to:

https://api.slotflow.dev/v1

Authentication

Every request requires an API key passed as a Bearer token:

Authorization: Bearer sk_live_your_api_key

Get your API key from the Slotflow Dashboard. See the Authentication guide for security best practices.

Request format

• Use Content-Type: application/json for request bodies
• All timestamps are ISO 8601 UTC (e.g. 2026-03-15T14:00:00.000Z)
• Dates are YYYY-MM-DD format (e.g. 2026-03-15)

Response format

Successful responses return JSON with the resource data:

1
{
2
  "id": "bk_a1b2c3",
3
  "human_id": "hu_x1y2z3",
4
  "starts_at": "2026-03-15T14:00:00.000Z",
5
  "ends_at": "2026-03-15T14:30:00.000Z",
6
  "status": "confirmed"
7
}

Error format

All errors follow a consistent structure:

1
{
2
  "error": {
3
    "code": "SLOT_UNAVAILABLE",
4
    "message": "This time slot has already been booked.",
5
    "status": 409
6
  }
7
}

Always switch on error.code (stable), not error.message (may change).

See Error Handling for detailed agent strategies for each error.

SDKs

• Node.js SDK — npm install slotflow
• Python SDK — coming soon