REST API v1

Developer API

Integrate AI Receptionist into your application. Create receptionists, manage conversations, capture leads, and send SMS — all programmatically.

Quick Start

1. Get your API key from the Dashboard → API Keys page.

2. Include it as a Bearer token in all requests:

curl -X POST https://aireceptionist.fit/api/v1/chat \
  -H "Authorization: Bearer air_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "receptionistId": "your_receptionist_id",
    "message": "Hello, I need to book an appointment"
  }'
Base URL: https://aireceptionist.fit/api/v1

Authentication

All API requests require a valid API key passed as a Bearer token in the Authorization header.

Authorization: Bearer air_your_api_key_here

API keys are prefixed with air_. You can generate and manage keys from your dashboard. Keys are shown only once on creation — store them securely.

Capabilities

Receptionists

Create, configure, and manage AI receptionists programmatically

Conversations

Send messages and receive intelligent AI responses

Lead Capture

Automatically extract and retrieve lead information

SMS

Send text messages from provisioned phone numbers

Usage Tracking

Monitor API usage, limits, and overage in real-time

API Keys

Generate, manage, and revoke API keys from your dashboard

Endpoints

Error Handling

The API uses standard HTTP status codes:

StatusMeaning
200Success
201Created
400Bad Request — missing or invalid parameters
401Unauthorized — invalid or missing API key
403Forbidden — plan limit exceeded
404Not Found — resource doesn\'t exist
500Internal Server Error
502AI service temporarily unavailable

🌐 ARD Federation (Agentic Resource Discovery)

Make your AI receptionist services discoverable by any AI agent in the ecosystem. ARD is an open standard that lets agents find and use tools published by any organization.

Partner Catalog Endpoint

GET /api/v1/partner-catalog
# Returns your ARD-compliant ai-catalog.json

# Customize with query params:
?brand=YourBrand&domain=yourdomain.com&[email protected]

How to Federate

1

Fetch your catalog

Call GET /api/v1/partner-catalog with your API key and branding params

2

Host on your domain

Serve the response at yourdomain.com/.well-known/ai-catalog.json

3

Get discovered

ARD registries will index your capabilities — AI agents worldwide can find and use your services

Example Catalog Response

{
  "specVersion": "1.0",
  "host": "yourdomain.com",
  "publisher": { "name": "Your Brand" },
  "entries": [
    {
      "identifier": "urn:ai:your-brand:api:chat",
      "displayName": "Your Brand — AI Chat",
      "type": "application/vnd.ai.chat+json",
      "url": "https://aireceptionist.fit/api/v1/chat",
      "capabilities": ["multi-turn-conversation", "lead-capture"]
    }
  ]
}

Ready to integrate?

Get your API key and start building in minutes.