# 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. - **How-To Guides** - [How to log in and reset your password](/docs/getting-started/log-in-and-reset-password): Sign in to the DealerAI portal and recover access if you forget your password. - [How to invite a staff member](/docs/getting-started/invite-a-staff-member): Add a new user to your dealership or organization and assign the right role. - [How to switch between dealerships](/docs/getting-started/switch-between-dealerships): Change the active dealership when you have access to multiple stores in an organization. - [How to update your profile and notifications](/docs/getting-started/update-your-profile): Edit your personal details, change your avatar, and choose how DealerAI notifies you. - 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. - **How-To Guides** - [How to pause and resume AI](/docs/portal/conversations/pause-and-resume-ai): Take over a conversation from the bot, then hand control back when you're done. - [How to add conversation notes](/docs/portal/conversations/add-conversation-notes): Attach internal notes to a conversation for your team to reference later. - [How to send a lead to CRM](/docs/portal/conversations/send-a-lead-to-crm): Push a conversation's customer details to your CRM as an ADF lead. - 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. - **How-To Guides** - [How to edit an agent prompt](/docs/portal/agents/edit-an-agent-prompt): Modify the system prompt that controls how a specific AI agent behaves and responds. - [How to configure agent parameters](/docs/portal/agents/configure-agent-parameters): Set the tools, actions, and behavior settings that control what an AI agent can do. - [How to set up outbound agents](/docs/portal/agents/set-up-outbound-agents): Configure AI agents for outbound communication through DealerAI Reach. - [How to use common prompts](/docs/portal/agents/use-common-prompts): Apply shared prompt templates across multiple AI agents for consistent behavior. - Reach: undefined - [Reach](/docs/portal/reach): Configure multi-channel follow-up, lead routing, fallback behavior, and inbound lead sequences from the Reach section. - **How-To Guides** - [How to enable and configure Reach](/docs/portal/reach/enable-and-configure-reach): Activate DealerAI Reach and set your preferred communication channels. - [How to set up follow-up sequences](/docs/portal/reach/set-up-follow-up-sequences): Create multi-step automated follow-up messages that engage leads over time. - [How to configure inbound sequences](/docs/portal/reach/configure-inbound-sequences): Set up automated responses for leads arriving from external sources. - [How to configure re-engagement](/docs/portal/reach/configure-re-engagement): Set up campaigns that automatically reach out to lapsed leads. - [How to configure email settings](/docs/portal/reach/configure-email-settings): Set up inbound and outbound email addresses and signatures for Reach. - 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. - **How-To Guides** - [How to edit contact details](/docs/portal/contacts/edit-contact-details): Update a contact's phone number, email, address, or other preferences. - [How to view contact activity](/docs/portal/contacts/view-contact-activity): Review the full activity timeline and audit trail for a contact. - 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. - **How-To Guides** - [How to add a fact to the Knowledge Base](/docs/portal/knowledge-base/add-a-fact): Add a new piece of dealership reference content the AI can draw on during conversations. - [How to extract knowledge from your website](/docs/portal/knowledge-base/extract-from-website): Seed or refresh the Knowledge Base by importing content directly from a dealership URL. - [How to retrain the AI after Knowledge Base updates](/docs/portal/knowledge-base/retrain-the-ai): Push your latest Knowledge Base edits into production so the AI uses them in live conversations. - [How to test that the AI uses your latest knowledge](/docs/portal/knowledge-base/test-ai-knowledge): Verify the AI's answers reflect the most recent Knowledge Base updates before customers see them. - [How to organize the Knowledge Base by topic](/docs/portal/knowledge-base/organize-by-topic): Structure entries with the Table of Contents so they're easy to maintain and the AI uses them confidently. - Promotions: undefined - [Promotions](/docs/portal/promotions): Manage dealership offers, train updates, and maintain promotion records used by DealerAI. - **How-To Guides** - [How to create a promotion](/docs/portal/promotions/create-a-promotion): Add a new special offer that the AI can share with customers. - [How to edit or deactivate a promotion](/docs/portal/promotions/edit-or-deactivate-a-promotion): Modify promotion details or toggle a promotion's active status. - [How to train AI on promotions](/docs/portal/promotions/train-ai-on-promotions): Sync your promotions into the AI's knowledge base so it can reference them in conversations. - [How to extract promotions from a URL](/docs/portal/promotions/extract-promotions-from-url): Automatically pull promotion details from a webpage into DealerAI. - Services: undefined - [Services](/docs/portal/vehicle-services): Search, add, and train dealership service offerings used by DealerAI. - **How-To Guides** - [How to add a service](/docs/portal/vehicle-services/add-a-service): Create a new service item with pricing and description for the AI to offer. - [How to edit or remove a service](/docs/portal/vehicle-services/edit-or-remove-a-service): Modify an existing service's details or delete it from your catalog. - [How to toggle bookable status](/docs/portal/vehicle-services/toggle-bookable-status): Enable or disable online appointment booking for a specific service. - Holidays: undefined - [Holidays](/docs/portal/holidays): Configure dealership closure dates so the AI knows when your dealership is unavailable and adjusts its responses accordingly. - **How-To Guides** - [How to add a holiday](/docs/portal/holidays/add-a-holiday): Add a closure date so DealerAI knows your dealership is unavailable. - [How to set recurring holidays](/docs/portal/holidays/set-recurring-holidays): Manage annual closure dates so DealerAI stays accurate year after year. - [How to edit or remove a holiday](/docs/portal/holidays/edit-or-remove-a-holiday): Update the date, name, or remarks on a holiday — or delete it when it's no longer needed. - Settings: undefined - [Settings](/docs/portal/settings): Configure dealership profile, messaging channels, hours, notifications, integrations, and feature behavior from the Settings section. - **Settings Reference** - [General Info](/docs/portal/settings/general-info): Configure the dealership's name, website URLs, locations, phone numbers, email addresses, and inventory link settings. - [Departments](/docs/portal/settings/departments): Manage dealership staff and department contacts that the AI can share with customers. - [Notifications](/docs/portal/settings/notifications): Configure push notification frequency and email alerts for new conversations and unassigned chats. - [Webchat](/docs/portal/settings/webchat): Customize the DealerAI webchat widget's avatar, brand colors, welcome messages, action buttons, and CSS styling. - [Analytics Tracking](/docs/portal/settings/analytics-tracking): Enable and configure Google Analytics tracking for the DealerAI webchat widget. - [Facebook & Instagram](/docs/portal/settings/facebook-and-instagram): Connect Facebook pages and Instagram accounts to enable AI-powered messaging on Meta channels. - [SMS](/docs/portal/settings/sms): View the dealership's assigned SMS number and configure AI activation and the welcome message for incoming texts. - [Hours](/docs/portal/settings/hours): Set the dealership's timezone and business hours for each department so the AI knows when the dealership is open. - [Activation and Features](/docs/portal/settings/activation-and-features): Control chatbot activation, supported languages, auto-off schedules, lease and finance estimators, anti-spam settings, and other feature flags. - [Active Messages](/docs/portal/settings/active-messages): Configure URL-based rules that trigger custom messages or action buttons when customers visit specific pages on the dealership website. - [Lead Generation](/docs/portal/settings/lead-generation): Configure how DealerAI delivers leads to the dealership via HTML email and ADF format. - [Voice Settings](/docs/portal/settings/voice-settings): Configure the AI voice agent's voice, tone, call forwarding, duration limits, reminders, and background noise for inbound and outbound calls. - [Whitelisted Domain](/docs/portal/settings/whitelisted-domain): Restrict which domains are allowed to embed and load the DealerAI webchat widget. - **How-To Guides** - [How to update dealership info](/docs/portal/settings/update-dealership-info): Edit your dealership's name, address, phone numbers, and general information. - [How to configure business hours](/docs/portal/settings/configure-business-hours): Set your dealership's daily opening and closing times. - [How to customize webchat](/docs/portal/settings/customize-webchat): Brand your chat widget with custom colors, avatar, and welcome message. - 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. - User Profile: undefined - [User Profile](/docs/portal/user-profile): View and update your personal account details, avatar, password, and email signature from the User Profile panel. - 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 and automotive platforms. - [Facebook](/docs/integrations/facebook): Grant DealerAI access to your dealership's Facebook Page so the chatbot can respond to Messenger conversations. - 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. - [List conversations](/docs/api/api/v1/assistant-data/conversations/get): Returns a paginated list of conversation records for the authenticated dealer. Supports filtering by dealership, channel, free-text query, and creation date range, and can optionally include an AI-generated summary for each conversation. - [List leads](/docs/api/api/v1/assistant-data/leads/get): Returns a paginated list of leads captured by the assistant. Supports filtering by dealership, lead type, channel, free-text query, and creation date range, with an optional AI-generated summary per lead. - [List appointments](/docs/api/api/v1/assistant-data/appointments/get): Returns a paginated list of appointments booked through the assistant. Supports filtering by dealership, appointment type, free-text query, and date range, with an optional AI-generated summary per appointment. - [List predefined assistant tasks](/docs/api/api/v1/assistant/predefined-tasks/get): Returns the catalog of predefined assistant tasks available to your account, including each task key and the parameters it accepts. Use a task key with the execute endpoint to run it. - [Execute a predefined assistant task](/docs/api/api/v1/assistant/predefined-tasks/taskkey/execute/post): Runs the predefined assistant task identified by taskKey using the parameters supplied in the request body, and returns the task result. Use the predefined-tasks list endpoint to discover valid task keys and their expected parameters. - [Get assistant capabilities](/docs/api/api/v1/assistant/threads/capabilities/get): Returns the capabilities the AI assistant currently supports for your account, such as available tools, data sources, and predefined task categories. Use this to discover what the assistant can do before starting a thread. - [List assistant threads](/docs/api/api/v1/assistant/threads/get): Returns the most recent AI assistant conversation threads for the authenticated dealer. Use the take query parameter to limit how many threads are returned. - [Send a message to the assistant](/docs/api/api/v1/assistant/threads/message/post): Sends a user message to the AI assistant. If no thread is specified a new thread is created. The request is accepted asynchronously (202) and processed as a run; poll the run or its events endpoint to retrieve the assistant's response. - [Get an assistant thread](/docs/api/api/v1/assistant/threads/threadid/get): Returns the metadata and current state of a single assistant thread, including its run status. Returns 404 if the thread does not exist or does not belong to the authenticated dealer. - [Delete an assistant thread](/docs/api/api/v1/assistant/threads/threadid/delete): Permanently deletes the specified assistant thread and its messages. Returns 409 if the thread has an active run that must complete or be cancelled first. - [List messages in a thread](/docs/api/api/v1/assistant/threads/threadid/messages/get): Returns the messages exchanged in the specified assistant thread in chronological order. Use the take query parameter to limit how many messages are returned. - [Get a run](/docs/api/api/v1/assistant/threads/threadid/runs/runid/get): Returns the status and result of a single assistant run within a thread. Poll this endpoint after sending a message to determine when the assistant has finished responding. - [Stream run events](/docs/api/api/v1/assistant/threads/threadid/runs/runid/events/get): Returns the event stream produced by an assistant run, such as incremental output and tool-call activity. Use the Cursor and Take query parameters to page through events as the run progresses. - [Cancel a thread run](/docs/api/api/v1/assistant/threads/threadid/cancel/post): Requests cancellation of the active run on the specified thread. The request is accepted asynchronously (202); the run transitions to a cancelled state once cancellation completes. - [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.