Download OpenAPI specification:Download
Partner API for voice AI bots to search availability and book appointments.
Use your partner API key (starts with sk_ptnr_) in the Authorization header:
Authorization: Bearer sk_ptnr_YOUR_PARTNER_KEY
bot_idAll errors follow a consistent format:
{
"error": {
"code": "error_code",
"message": "Human-readable message"
}
}
Appointment booking endpoints for voice AI partners.
These endpoints allow voice AI bots to search for available appointment slots and create bookings on behalf of end customers.
Search for available appointment slots.
The request is relayed to the platform's webhook endpoint. The response format depends on the platform's implementation.
| bot_id required | string The bot ID making the request |
required | object (AvailabilityQuery) |
required | Array of objects (Availability) | ||||
Array
| |||||
{- "bot_id": "bot_01h2xcejqtf2nbrexx3vqjhp41",
- "query": {
- "filter": {
- "start_at_range": {
- "start_at": "2024-01-15T09:00:00Z",
- "end_at": "2024-01-15T17:00:00Z"
}
}
}
}{- "availabilities": [
- {
- "start_at": "2024-01-15T10:00:00Z",
- "duration_minutes": 30
}, - {
- "start_at": "2024-01-15T10:30:00Z",
- "duration_minutes": 30
}
]
}Book an appointment slot.
Requires an Idempotency-Key header to ensure the booking is not
duplicated if the request is retried.
The request is relayed to the platform's webhook endpoint. The response format depends on the platform's implementation.
| Idempotency-Key required | string Example: booking-req-123456 Unique key to ensure idempotent booking creation. If the same key is used again, the original booking is returned. |
| bot_id required | string The bot ID making the request |
required | object (BookingDetails) |
required | object | ||||||||||||||||
| |||||||||||||||||
{- "bot_id": "bot_01h2xcejqtf2nbrexx3vqjhp41",
- "booking": {
- "start_at": "2024-01-15T10:00:00Z",
- "duration_minutes": 30,
- "customer": {
- "phone": "+15551234567",
- "name": "John Doe",
- "email": "john@example.com"
}, - "notes": "Initial consultation - referred by AI assistant"
}
}{- "booking": {
- "id": "bkg_01h2xcejqtf2nbrexx3vqjhp41",
- "status": "confirmed",
- "start_at": "2024-01-15T10:00:00Z",
- "end_at": "2024-01-15T10:30:00Z",
- "customer": {
- "phone": "+15551234567",
- "name": "John Doe"
}, - "location": {
- "name": "Main Office",
- "address": "123 Main St, City, ST 12345"
}, - "created_at": "2024-01-10T14:30:00Z"
}
}