# Apologist AI | Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.apologist.ai/_mcp/server ## Docs - [Overview](https://docs.apologist.ai/console/get-started/overview.md): Task-oriented guides for configuring and managing Apologist AI Console - [Quickstart](https://docs.apologist.ai/console/get-started/quickstart.md): Create your first Agent in Apologist AI Console - [Branding](https://docs.apologist.ai/console/configuration/branding.md): Give an Agent your ministry's greeting, logo, colors, and credit - [Configuring Languages](https://docs.apologist.ai/console/configuration/configuring-languages.md): Configure language and locale behavior for an Apologist AI Console Agent - [Available Languages](https://docs.apologist.ai/console/configuration/configuring-languages/available-languages.md): Languages an Agent can support, with local names, codes, and translation providers - [Configuring Bible Translations](https://docs.apologist.ai/console/configuration/configuring-bible-translations.md): Choose scripture translation behavior for an Apologist AI Console Agent - [Available Bible Translations](https://docs.apologist.ai/console/configuration/configuring-bible-translations/available-bible-translations.md): Bible translations an Agent can quote, with local names, abbreviations, licensors, and providers - [Configuring Scripture Plugins](https://docs.apologist.ai/console/configuration/configuring-scripture-plugins.md): Attach hosted or external Scripture plugins that run when an Agent quotes or cites a verse - [Customizing Instructions](https://docs.apologist.ai/console/configuration/customizing-instructions.md): Shape Agent behavior with instructions in Apologist AI Console - [Curating Sources](https://docs.apologist.ai/console/configuration/curating-sources.md): Ground Agent responses in trusted sources through Apologist AI Console - [Configuring Advanced Context](https://docs.apologist.ai/console/configuration/configuring-advanced-context.md): Tune the context an Apologist AI Console Agent receives with each prompt - [Choosing an AI Model](https://docs.apologist.ai/console/configuration/choosing-an-ai-model.md): Choose a model for an Apologist AI Agent, tune supported parameters, and verify the result - [Configuring Message Retention](https://docs.apologist.ai/console/configuration/configuring-message-retention.md): Set how long an Agent keeps readable chat text, and how that text is redacted - [Standalone Web UI](https://docs.apologist.ai/console/interfaces/standalone-web-ui.md): Publish an Agent at its own web address through Apologist AI Console - [Embedding On a Website](https://docs.apologist.ai/console/interfaces/embedding-on-a-website.md): Add an Agent to your existing website with the Beacon embed snippet - [Progressive Web Apps (PWA)](https://docs.apologist.ai/console/interfaces/progressive-web-apps.md): Let visitors install an Agent to their device as an app - [Messaging / Social Channels](https://docs.apologist.ai/console/interfaces/messaging-social-channels.md): Connect an Agent to messaging and social platforms in Apologist AI Console - [Chatwoot Integration](https://docs.apologist.ai/console/interfaces/chatwoot.md): How an Agent answers as a Chatwoot Agent Bot, and how staff take over - [API And MCP](https://docs.apologist.ai/console/interfaces/api-and-mcp.md): Enable programmatic access to an Agent and issue API keys in Apologist AI Console - [How Content Works](https://docs.apologist.ai/console/content/how-content-works.md): What Sources and Collections are, and how your content reaches an Agent - [Adding And Editing Content](https://docs.apologist.ai/console/content/adding-and-editing-content.md): Add books, articles, web pages, recordings and data as Sources, get their text ready for your Agent, and keep them current - [Organizing Content](https://docs.apologist.ai/console/content/organizing-content.md): Group Sources into Collections and Lists, label them with Tags and Categories, and record metadata your Agent can rank by - [Where Your Content Appears](https://docs.apologist.ai/console/content/where-your-content-appears.md): Control how a Source is presented in your Agent's answers and on the Directory, list it publicly, and see how often it is used - [Attribution](https://docs.apologist.ai/console/content/attribution.md): Credit the people behind your content as Contributors, and describe your ministry as your team's Organization - [Advanced Branding](https://docs.apologist.ai/console/experience/advanced-branding.md): Set an Agent's footer, background, fonts, custom styles, page metadata, and transition messages - [Starter Prompts](https://docs.apologist.ai/console/experience/starter-prompts.md): Offer suggested opening questions on an Agent's intro screen - [Related Media](https://docs.apologist.ai/console/experience/related-media.md): Suggest videos and podcast episodes alongside an Agent's answers - [Voice To Voice](https://docs.apologist.ai/console/experience/voice-to-voice.md): Let visitors speak with an Agent and hear its answers out loud - [Evaluators](https://docs.apologist.ai/console/orchestration/evaluators.md): Judge what a visitor said, or what an Agent answered, and act on the verdict - [Audiences](https://docs.apologist.ai/console/orchestration/audiences.md): Save a definition of who a rule applies to, and reuse it across Agents - [Responder Routing](https://docs.apologist.ai/console/orchestration/responder-routing.md): Give one Agent several personas, and let it choose which one answers each prompt - [Message Merge Tags](https://docs.apologist.ai/console/orchestration/message-merge-tags.md): Write content once and let the Agent fill in the details for each visitor - [Calls To Action](https://docs.apologist.ai/console/orchestration/calls-to-action.md): Show a visitor something you wrote, at the moment the conversation calls for it - [Custom Guardrails](https://docs.apologist.ai/console/orchestration/custom-guardrails.md): Stop a conversation going somewhere it should not, before or after the Agent answers - [Automations](https://docs.apologist.ai/console/orchestration/automations.md): Label what visitors ask about, and follow up on a conversation after the Agent has finished answering - [Benchmarks](https://docs.apologist.ai/console/orchestration/benchmarks.md): Test an Agent's answers against a question bank and score them with your Evaluators - [Notifications](https://docs.apologist.ai/console/orchestration/notifications.md): Be told when something happens on your Agent, by webhook, Slack or email - [Agent Sync](https://docs.apologist.ai/console/orchestration/agent-sync.md): Planned guidance for Agent Sync in Apologist AI Console - [Chat Logs](https://docs.apologist.ai/console/observability/chat-logs.md): Read what people asked an Agent and how it answered - [Analytics](https://docs.apologist.ai/console/observability/analytics.md): See how much an Agent is used, by whom, and at what cost - [Custom Tracking Scripts](https://docs.apologist.ai/console/observability/custom-tracking-scripts.md): Run your own analytics on an Agent's pages, and listen for what visitors do - [User Profile](https://docs.apologist.ai/console/account-and-billing/manage-your-profile.md): Planned guidance for User Profile in Apologist AI Console - [Team Members](https://docs.apologist.ai/console/account-and-billing/team-members.md): Planned guidance for Team Members in Apologist AI Console - [Credits](https://docs.apologist.ai/console/account-and-billing/credits.md): Planned guidance for Credits in Apologist AI Console - [Subscriptions](https://docs.apologist.ai/console/account-and-billing/subscriptions.md): Planned guidance for Subscriptions in Apologist AI Console - [Payments](https://docs.apologist.ai/console/account-and-billing/payment-methods-past-invoices.md): Planned guidance for Payments in Apologist AI Console - [Glossary Of Terms](https://docs.apologist.ai/console/glossary.md): Definitions for Apologist Console, Agent, evaluator, content, and API concepts - [Agent API](https://docs.apologist.ai/agent-api/overview.md): Build Apologist AI Agent responses into your own applications - [Getting Started](https://docs.apologist.ai/agent-api/getting-started.md): Plan an integration with Apologist AI Agent API - [Tracing](https://docs.apologist.ai/agent-api/tracing.md): Continue a W3C trace through Agent API requests and stitch notification webhooks - [SDKs](https://docs.apologist.ai/agent-api/sdks.md): Official client libraries for the Agent API - [Scrub And Anonymize](https://docs.apologist.ai/agent-api/scrub-and-anonymize-users.md): Rewrite stored message text for one user or one chat completion without deleting records or identifiers ## API Docs - API Reference > Agent [Pause Agent](https://docs.apologist.ai/agent-api/api-reference/agent/pause-agent.md) - API Reference > Agent [Resume Agent](https://docs.apologist.ai/agent-api/api-reference/agent/resume-agent.md) - API Reference > Benchmark Runs [Get Benchmark Run](https://docs.apologist.ai/agent-api/api-reference/benchmark-runs/get-benchmark-run.md) - API Reference > Benchmark Runs [List Benchmark Runs](https://docs.apologist.ai/agent-api/api-reference/benchmark-runs/list-benchmark-runs.md) - API Reference > Benchmark Runs [Create Benchmark Run](https://docs.apologist.ai/agent-api/api-reference/benchmark-runs/run-benchmark.md) - API Reference > Channels [Chatwoot Channel Status](https://docs.apologist.ai/agent-api/api-reference/channels/get-chatwoot-channel-status.md) - API Reference > Channels [Chatwoot Agent Bot Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-chatwoot-webhook.md) - API Reference > Channels [Discord Channel Status](https://docs.apologist.ai/agent-api/api-reference/channels/get-discord-channel-status.md) - API Reference > Channels [Discord Interaction Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-discord-interaction.md) - API Reference > Channels [Facebook/Messenger Webhook Verification](https://docs.apologist.ai/agent-api/api-reference/channels/verify-facebook-webhook.md) - API Reference > Channels [Facebook/Messenger Message Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-facebook-message.md) - API Reference > Channels [Instagram Integration Privacy Policy](https://docs.apologist.ai/agent-api/api-reference/channels/get-instagram-privacy-policy.md) - API Reference > Channels [LINE Channel Status](https://docs.apologist.ai/agent-api/api-reference/channels/get-line-channel-status.md) - API Reference > Channels [LINE Messaging API Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-line-webhook.md) - API Reference > Channels [Telegram Message Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-telegram-update.md) - API Reference > Channels [Twilio SMS/WhatsApp Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-twilio-message.md) - API Reference > Channels [WhatsApp Webhook Verification](https://docs.apologist.ai/agent-api/api-reference/channels/verify-whats-app-webhook.md) - API Reference > Channels [WhatsApp Message Webhook](https://docs.apologist.ai/agent-api/api-reference/channels/receive-whats-app-message.md) - API Reference > Chat Completions [Get Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/get-chat-completion.md) - API Reference > Chat Completions [List Chat Completions](https://docs.apologist.ai/agent-api/api-reference/chat-completions/list-chat-completions.md) - API Reference > Chat Completions [Create Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/create-chat-completion.md) - API Reference > Chat Completions [Like / Unlike Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/like-completion.md) - API Reference > Chat Completions [Flag / Unflag Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/flag-completion.md) - API Reference > Chat Completions [Submit Feedback For Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/feedback-completion.md) - API Reference > Chat Completions [Anonymize Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/anonymize-completion.md) - API Reference > Chat Completions [Scrub Chat Completion](https://docs.apologist.ai/agent-api/api-reference/chat-completions/scrub-completion.md) - API Reference > Conversations [Get Conversation](https://docs.apologist.ai/agent-api/api-reference/conversations/get-conversation.md) - API Reference > Conversations [List Conversations](https://docs.apologist.ai/agent-api/api-reference/conversations/list-conversations.md) - API Reference > Conversations [Pause Conversation](https://docs.apologist.ai/agent-api/api-reference/conversations/pause-conversation.md) - API Reference > Conversations [Resume Conversation](https://docs.apologist.ai/agent-api/api-reference/conversations/resume-conversation.md) - API Reference > Evaluations [Get Evaluation](https://docs.apologist.ai/agent-api/api-reference/evaluations/get-evaluation.md) - API Reference > Evaluations [List Evaluations](https://docs.apologist.ai/agent-api/api-reference/evaluations/list-evaluations.md) - API Reference > Evaluations [Create Evaluation](https://docs.apologist.ai/agent-api/api-reference/evaluations/evaluate-content.md) - API Reference > Evaluations [Match Calls To Action](https://docs.apologist.ai/agent-api/api-reference/evaluations/match-ctas.md) - API Reference > Events [Log Corpus Item Referral & Redirect](https://docs.apologist.ai/agent-api/api-reference/events/log-corpus-referral-redirect.md) - API Reference > Events [Log CTA Click](https://docs.apologist.ai/agent-api/api-reference/events/log-cta-click.md) - API Reference > Events [Log Corpus Item Impression](https://docs.apologist.ai/agent-api/api-reference/events/log-corpus-impression.md) - API Reference > Events [Log Corpus Item Referral](https://docs.apologist.ai/agent-api/api-reference/events/log-corpus-referral.md) - API Reference > Events [Log Corpus Item View](https://docs.apologist.ai/agent-api/api-reference/events/log-corpus-view.md) - API Reference > Outgoing Webhooks [Chat Completion Events](https://docs.apologist.ai/agent-api/api-reference/outgoing-webhooks/receive-agent-webhook.md) - API Reference > Semantic Search [Search Corpus](https://docs.apologist.ai/agent-api/api-reference/semantic-search/search-corpus.md) - API Reference > Shares [Get Share Messages](https://docs.apologist.ai/agent-api/api-reference/shares/get-shared-messages.md) - API Reference > Shares [Share Chat Completion](https://docs.apologist.ai/agent-api/api-reference/shares/share-completion.md) - API Reference > Users [Get User](https://docs.apologist.ai/agent-api/api-reference/users/get-user.md) - API Reference > Users [List Users](https://docs.apologist.ai/agent-api/api-reference/users/list-users.md) - API Reference > Users [List User Flags](https://docs.apologist.ai/agent-api/api-reference/users/list-user-flags.md) - API Reference > Users [Update User](https://docs.apologist.ai/agent-api/api-reference/users/update-user.md) - API Reference > Users [Anonymize Chat Logs](https://docs.apologist.ai/agent-api/api-reference/users/anonymize-user.md) - API Reference > Users [Scrub Chat Logs](https://docs.apologist.ai/agent-api/api-reference/users/scrub-user.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.apologist.ai/openapi.json) - [OpenAPI YAML](https://docs.apologist.ai/openapi.yaml)