> ## Documentation Index > Fetch the complete documentation index at: https://docs.famulor.io/llms.txt > Use this file to discover all available pages before exploring further. # Create a booking > Book a free start time of an event type for an invitee. `start` must come from *List free slots*, unless `allow_outside_availability` is true (staff override: any future time within 2 years that does not overlap a confirmed booking of the same event type); otherwise a slot that is no longer free returns `409`. The invitee receives the confirmation email with a calendar invitation (when an email address is given), and the event type's webhook and automations fire. Stored `source` is `api`. There is no idempotency key: retrying the same request for the same slot returns `409` via the database's overlap constraint. A `503` here can mean either request protection is temporarily unavailable (`internal_error`) or the availability engine itself failed to load (`service_unavailable`, message "Could not load availability") — see *AvailabilityOrProtectionUnavailable*. **Required scope:** `bookings:write` (keys without scope restrictions have full access). ## OpenAPI ````yaml /api-reference/openapi.json post /bookings openapi: 3.1.0 info: title: Famulor API version: 1.0.0 description: >- REST API for Famulor. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. REST operations require API Access through the workspace plan or a recurring add-on. Without it, regular operations return `403 api_access_required`. The invoice-payment and billing-portal operations remain available with a valid `billing:write` credential after a failed plan payment so an authorized owner, admin, or billing member can recover billing. The same customer-facing capabilities are available as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials, scopes, and workspace access. MCP availability is controlled separately by Connect AI / MCP, not by API Access. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: Famulor Loop description: >- Personal business-phone access, directory, presence, devices, and Loop call recents. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Milian Missions description: Recurring jobs that Milian runs unattended on schedule. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage white-label customer accounts, defaults, credit transfers and customer plan offers. Each endpoint documents its required scope and workspace eligibility. - name: API Keys description: >- Self-service API keys for the calling workspace or a same-brand workspace where the credential's user is owner/admin. A key can only mint further keys with a scope subset of its own. - name: Workspaces description: >- List visible workspaces, create an additional workspace for the key owner, and mint a dedicated credential for a selected owner/admin workspace. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /bookings: post: tags: - Bookings summary: Create a booking description: >- Book a free start time of an event type for an invitee. `start` must come from *List free slots*, unless `allow_outside_availability` is true (staff override: any future time within 2 years that does not overlap a confirmed booking of the same event type); otherwise a slot that is no longer free returns `409`. The invitee receives the confirmation email with a calendar invitation (when an email address is given), and the event type's webhook and automations fire. Stored `source` is `api`. There is no idempotency key: retrying the same request for the same slot returns `409` via the database's overlap constraint. A `503` here can mean either request protection is temporarily unavailable (`internal_error`) or the availability engine itself failed to load (`service_unavailable`, message "Could not load availability") — see *AvailabilityOrProtectionUnavailable*. **Required scope:** `bookings:write` (keys without scope restrictions have full access). operationId: createBooking requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BookingCreateInput' example: event_type_id: 5c9f6e2a-4b1d-4b7a-9c1e-8f2a1b3c4d5e start: '2026-08-14T09:00:00Z' name: Anna Schmidt email: anna@example.com responses: '201': description: The created booking. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/BookingCreated' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/AvailabilityOrProtectionUnavailable' components: schemas: BookingCreateInput: type: object required: - event_type_id - start - name properties: event_type_id: type: string format: uuid description: Event type ID. start: type: string format: date-time description: >- Start time in ISO 8601 UTC — must be a value returned by List free slots, unless allow_outside_availability is set. name: type: string minLength: 1 maxLength: 128 description: Invitee name. email: type: string description: >- Invitee email — required when the event type requires it (e.g. a Google Meet/Teams location). phone: type: string description: >- International format, e.g. +4915123456789. Required when the event type requires it. notes: type: string maxLength: 2000 description: Notes attached to the booking. answers: type: object description: >- Answers to the event type's custom booking questions, keyed by BookingField.id. additionalProperties: true timezone: type: string description: >- IANA time zone used for the invitee's confirmation email and calendar invite; does not affect how `start` is parsed. Default the workspace time zone. hour_cycle: type: string enum: - 12h - 24h description: Time format used in the invitee's confirmation email; default 24h. allow_outside_availability: type: boolean default: false description: >- Set true to book outside the event type's open times (staff override). Any future time within the next 2 years is accepted; the time must not overlap another confirmed booking of the same event type. Guests on the public booking page only ever see open times. BookingCreated: allOf: - $ref: '#/components/schemas/Booking' - type: object properties: email_scheduled: type: boolean description: >- Whether a confirmation email was scheduled (an email address was given). meeting_url: type: - string - 'null' description: Video meeting URL when the event type uses Google Meet/Teams. Booking: type: object properties: id: type: string format: uuid event_type_id: type: string format: uuid event_type_name: type: - string - 'null' event_type_slug: type: - string - 'null' invitee_name: type: string invitee_email: type: string invitee_phone: type: - string - 'null' invitee_timezone: type: string start_at: type: string format: date-time end_at: type: string format: date-time status: type: string enum: - confirmed - cancelled - completed - no_show source: type: string enum: - web - call - api - manual description: >- web = public booking page, call = booked by an assistant mid-call, api = created through the API, MCP or an AI agent on a messaging channel, manual = booked by a team member in the app (including Milian). call_id: type: - string - 'null' description: >- The call during which the assistant booked this appointment (source=call). notes: type: string answers: type: object description: >- Answers to the event type's custom booking questions, keyed by BookingField.id. additionalProperties: true created_at: type: string format: date-time ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - api_access_required - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - destination_forbidden - internal_error - service_unavailable description: >- Stable, machine-readable error code. `service_unavailable` is returned by POST /bookings and GET /booking-event-types/{id}/slots specifically when the availability engine could not be reached (see AvailabilityOrProtectionUnavailable). message: type: string description: Human-readable description of the error. responses: BadRequest: description: Invalid request body or parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_request message: '"to_number" is required (E.164 format, e.g. +4930123456).' Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The credential lacks the required scope or role, or the workspace does not have the required capability. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: scopeDenied: summary: Required scope is missing value: error: code: forbidden message: >- This API key is missing the required scope "assistants:write". apiAccessRequired: summary: API Access is not available value: error: code: api_access_required message: >- API Access is not available for this workspace. Review Settings → Plan. NotFound: description: Resource not found (or it belongs to another workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not_found message: Assistant not found Conflict: description: The resource is in a conflicting state. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: conflict message: Campaign is not running. RateLimited: description: Too many requests. Retry after the indicated delay. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: rate_limited message: Too many requests. Retry after the indicated delay. AvailabilityOrProtectionUnavailable: description: >- Either request protection is temporarily unavailable (code `internal_error`), or, specifically for this endpoint, the availability engine could not be reached (code `service_unavailable`, message "Could not load availability"). Retry after a short delay in both cases. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: requestProtectionUnavailable: summary: Request protection unavailable value: error: code: internal_error message: Request protection is temporarily unavailable. availabilityUnavailable: summary: Availability engine failed to load value: error: code: service_unavailable message: Could not load availability securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `billing:write`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access within the workspace's available capabilities. ````