# Documentation

- [DealerAI Documentation](/docs): Documentation for the DealerAI conversational AI platform for automotive dealerships.
- Getting Started: undefined
  - [Getting Started](/docs/getting-started): Get your dealership up and running with DealerAI by configuring your general settings and automated outreach.
- Portal Guide: undefined
  - [Portal Guide](/docs/portal): A complete guide to every section of the DealerAI management portal for dealership staff.
  - Conversations: undefined
    - [Conversations](/docs/portal/conversations): Monitor and manage live AI-led customer conversations across all channels from one unified inbox.
  - Analytics: undefined
    - [Analytics](/docs/portal/analytics): Review performance dashboards tracking conversation volume, lead conversion, and AI efficiency.
  - AI Agents: undefined
    - [AI Agents](/docs/portal/agents): Configure default agents, custom agents, outbound agents, and shared appointment behavior from the DealerAI portal.
  - Reach: undefined
    - [Reach](/docs/portal/reach): Configure multi-channel follow-up, lead routing, fallback behavior, and inbound lead sequences from the Reach section.
  - Appointments: undefined
    - [Appointments](/docs/portal/appointments): Review dealership bookings in calendar or table view, filter by type, and inspect appointment-related follow-up workflows.
  - Leads: undefined
    - [Leads](/docs/portal/leads): Review lead activity by date range, inspect conversation records, and queue follow-up actions from the Leads page.
  - Contacts: undefined
    - [Contacts](/docs/portal/contacts): Search, review, edit, and enroll dealership contacts into sequences from the portal Contacts page.
  - Mailbox: undefined
    - [Mailbox](/docs/portal/mailbox): Manage inbound email leads and ADF enquiries from your dealership's dedicated lead inbox.
  - Inventory: undefined
    - [Inventory](/docs/portal/inventory): Review new and used vehicle inventory, search inventory records, and inspect available vehicles from the Inventory page.
  - Knowledge Base: undefined
    - [Knowledge Base](/docs/portal/knowledge-base): Maintain dealership reference content, train updates, and manage structured knowledge entries used by DealerAI.
  - Promotions: undefined
    - [Promotions](/docs/portal/promotions): Manage dealership offers, train updates, and maintain promotion records used by DealerAI.
  - Services: undefined
    - [Services](/docs/portal/vehicle-services): Search, add, and train dealership service offerings used by DealerAI.
  - Holidays: undefined
    - [Holidays](/docs/portal/holidays): Configure dealership closure dates so the AI knows when your dealership is unavailable and adjusts its responses accordingly.
  - Settings: undefined
    - [Settings](/docs/portal/settings): Configure dealership profile, messaging channels, hours, notifications, integrations, and feature behavior from the Settings section.
  - Preview: undefined
    - [Preview](/docs/portal/preview): Test and visualise your dealership's webchat widget before it goes live on your website.
  - Subscription: undefined
    - [Subscription](/docs/portal/subscription): Manage your DealerAI subscription plan, billing information, and payment history.
  - Organizations: undefined
    - [Organizations](/docs/portal/organizations): Manage your organization's structure, including multiple dealership locations (stores) and the staff members associated with them.
- Webchat: undefined
  - [Webchat](/docs/webchat): Embed and configure the DealerAI webchat widget on your dealership website.
  - [Installation](/docs/webchat/installation): Embed the DealerAI webchat widget on your dealership website using a single script tag.
  - [Configuration](/docs/webchat/configuration): Customise the appearance and behaviour of the DealerAI webchat widget for your dealership.
  - [Customization](/docs/webchat/customization): Apply custom branding, themes, window styles, and CSS to the DealerAI webchat widget.
  - [Action Buttons](/docs/webchat/action-buttons): Configure quick-reply action buttons that appear on the webchat welcome screen.
  - [JavaScript SDK](/docs/webchat/sdk): Control the DealerAI webchat widget programmatically from your website JavaScript.
- Integrations: undefined
  - [Integrations](/docs/integrations): Connect DealerAI to external CRM systems, automotive platforms, and configure webhook event subscriptions.
- API Reference: undefined
  - [API Reference](/docs/api): DealerAI Public API — manage inventory, conversations, contacts, promotions, and more.
  - [Add or Update Contact](/docs/api/api/v1/ailm/contact/post): Creates a new contact or updates an existing one based on email or phone. This operation does not send any messages to the contact.
  - [Engage Contact](/docs/api/api/v1/ailm/engage/post): Creates or updates a contact and initiates a message to engage them. The message is queued for asynchronous delivery via the Bot Engine.
  - [Process ADF Lead](/docs/api/api/v1/ailm/outbound/adf/post): Parses an ADF (Auto/Lead Data Format) XML document, extracts customer information, creates or updates the contact, and initiates outbound engagement. The message is queued for asynchronous delivery.
  - [/api/v1/assistant-data/conversations](/docs/api/api/v1/assistant-data/conversations/get)
  - [/api/v1/assistant-data/leads](/docs/api/api/v1/assistant-data/leads/get)
  - [/api/v1/assistant-data/appointments](/docs/api/api/v1/assistant-data/appointments/get)
  - [/api/v1/assistant/predefined-tasks](/docs/api/api/v1/assistant/predefined-tasks/get)
  - [/api/v1/assistant/predefined-tasks/{taskKey}/execute](/docs/api/api/v1/assistant/predefined-tasks/taskkey/execute/post)
  - [/api/v1/assistant/threads/capabilities](/docs/api/api/v1/assistant/threads/capabilities/get)
  - [/api/v1/assistant/threads](/docs/api/api/v1/assistant/threads/get)
  - [/api/v1/assistant/threads/message](/docs/api/api/v1/assistant/threads/message/post)
  - [/api/v1/assistant/threads/{threadId}](/docs/api/api/v1/assistant/threads/threadid/get)
  - [/api/v1/assistant/threads/{threadId}](/docs/api/api/v1/assistant/threads/threadid/delete)
  - [/api/v1/assistant/threads/{threadId}/messages](/docs/api/api/v1/assistant/threads/threadid/messages/get)
  - [/api/v1/assistant/threads/{threadId}/runs/{runId}](/docs/api/api/v1/assistant/threads/threadid/runs/runid/get)
  - [/api/v1/assistant/threads/{threadId}/runs/{runId}/events](/docs/api/api/v1/assistant/threads/threadid/runs/runid/events/get)
  - [/api/v1/assistant/threads/{threadId}/cancel](/docs/api/api/v1/assistant/threads/threadid/cancel/post)
  - [Verify Authentication](/docs/api/api/v1/authentication/verify/post): Verifies the provided Basic Authentication credentials and returns the authenticated dealer ID.
  - [Get chats for the authenticated dealer.](/docs/api/api/v1/chats/chats/get): Read-only endpoint for listing chat conversations with optional filtering and pagination.
  - [Get a single chat conversation by id.](/docs/api/api/v1/chats/chats/conversationid/get): Read-only endpoint for fetching one chat conversation and optionally its messages.
  - [Get Conversation by ConversationId](/docs/api/api/v1/conversation/conversationid/get): Retrieves conversation data including user information, status, and optionally messages for the specified conversation ID.
  - [Get Conversations with Filtering and Pagination](/docs/api/api/v1/conversation/get): Retrieves a paginated list of conversations for the authenticated dealership with optional filtering by channel, status, dates, and archived status.
Results are ordered by LastModifiedDate.
  - [Notifies DealerAI that a retailer has enabled the CreditApp integration.](/docs/api/api/v1/webhooks/creditapp/integration-enabled/post): CreditApp signs the request body with HMAC-SHA256 using the shared secret key and sends
the hex-encoded signature in the `X-Credit-App-Signature` header.
The dealer is looked up by normalizing `retailerName` to a dealer ID
(e.g. "Bob's Motors" → "bobs-motors"). If no matching dealer exists, one is created.
  - [Get Dealership](/docs/api/api/v1/dealership/get): Retrieves the complete dealership profile and configuration for the authenticated dealership.
  - [Get Manufacturers](/docs/api/api/v1/manufacturer/get): Retrieves a paginated list of all vehicle manufacturers in the system.
  - [Get Models by Manufacturer](/docs/api/api/v1/manufacturer/manufacturerid/models/get): Retrieves a paginated list of car models for a specific manufacturer, optionally filtered by region.
  - [Get New Cars](/docs/api/api/v1/inventory/new/get): Retrieves a paginated list of new cars for the authenticated dealership, ordered by creation date.
  - [Delete All New Cars](/docs/api/api/v1/inventory/new/delete): Removes all new car inventory records for the authenticated dealership.
  - [Upload New Inventory CSV](/docs/api/api/v1/inventory/new/put): Uploads a CSV file containing new car inventory data and replaces all existing inventory for the dealership. Supports custom column mapping via query parameters.
  - [Get New Car by VIN](/docs/api/api/v1/inventory/new/vin/get): Retrieves a specific new car from the dealership's inventory by its VIN (Vehicle Identification Number).
  - [Delete New Car by VIN](/docs/api/api/v1/inventory/new/vin/delete): Removes a specific new car from the dealership's inventory by its VIN.
  - [Upload New Inventory JSON](/docs/api/api/v1/inventory/new/json/put): Uploads a JSON file containing new car inventory data and replaces all existing inventory for the dealership.
  - [Translate Search Query](/docs/api/api/v1/search/translate/post): Converts a natural language car search query into a structured logic expression using OpenAI. Returns filter criteria that can be used for precise inventory searches.
  - [Search Cars](/docs/api/api/v1/search/post): Searches both new and used car inventory using natural language queries. Translates the query into structured filters and returns matching vehicles from the dealership's inventory.
  - [Get Used Cars](/docs/api/api/v1/inventory/used/get): Retrieves a paginated list of used cars for the authenticated dealership, ordered by creation date.
  - [Delete All Used Cars](/docs/api/api/v1/inventory/used/delete): Removes all used car inventory records for the authenticated dealership.
  - [Upload Used Inventory CSV](/docs/api/api/v1/inventory/used/put): Uploads a CSV file containing used car inventory data and replaces all existing inventory for the dealership. Supports custom column mapping via query parameters.
  - [Upload Used Inventory JSON](/docs/api/api/v1/inventory/used/json/put): Uploads a JSON file containing used car inventory data and replaces all existing inventory for the dealership.
  - [Get Used Car by VIN](/docs/api/api/v1/inventory/used/vin/get): Retrieves a specific used car from the dealership's inventory by its VIN (Vehicle Identification Number).
  - [Delete Used Car by VIN](/docs/api/api/v1/inventory/used/vin/delete): Removes a specific used car from the dealership's inventory by its VIN.