# Annie Docs

## Docs

- [Apply blueprint to bot](https://docs.helloannie.com/api-reference/blueprints/apply-blueprint-to-bot.md): Apply a blueprint to a bot by providing values for all required variables. Each template in the blueprint is applied sequentially. Optionally deletes existing workflows and application history created by prior template or blueprint applications for the bot before applying the blueprint. Returns a jo…
- [Create blueprint](https://docs.helloannie.com/api-reference/blueprints/create-blueprint.md): Create a new blueprint by grouping multiple templates together. Variables are aggregated from all templates.
- [Delete blueprint](https://docs.helloannie.com/api-reference/blueprints/delete-blueprint.md): Delete a blueprint
- [Get blueprint](https://docs.helloannie.com/api-reference/blueprints/get-blueprint.md): Get a single blueprint by ID with its variables and template IDs
- [Get blueprint apply job status](https://docs.helloannie.com/api-reference/blueprints/get-blueprint-apply-job-status.md): Get the status and progress of a blueprint apply job
- [List blueprints](https://docs.helloannie.com/api-reference/blueprints/list-blueprints.md): List all blueprints for the authenticated organization
- [Delete bot webhook](https://docs.helloannie.com/api-reference/bot-webhooks/delete-bot-webhook.md): Remove the webhook configuration associated with a bot.
- [Get bot webhook](https://docs.helloannie.com/api-reference/bot-webhooks/get-bot-webhook.md): Retrieve the webhook configuration used for the specified bot.
- [Upsert bot webhook](https://docs.helloannie.com/api-reference/bot-webhooks/upsert-bot-webhook.md): Create or update the webhook configuration Annie will use to notify downstream systems. If `authToken` is provided, it will be passed to the webhook as a Bearer token in the Authorization header. If `authToken` is set to null, the token will be cleared and the webhook will not have an Authorization…
- [Create bot](https://docs.helloannie.com/api-reference/bots/create-bot.md): Provision a new Annie bot for the organization.
- [Delete bot](https://docs.helloannie.com/api-reference/bots/delete-bot.md): Permanently delete a bot that belongs to the organization.
- [Get bot](https://docs.helloannie.com/api-reference/bots/get-bot.md): Fetch a single bot by ID that belongs to the authenticated organization.
- [List bots](https://docs.helloannie.com/api-reference/bots/list-bots.md): Returns bots for the authenticated organization. Optionally filter by `orgId` or include child organization bots with `includeChildren`.
- [Update bot](https://docs.helloannie.com/api-reference/bots/update-bot.md): Modify mutable fields on a bot in the organization.
- [Start outbound call](https://docs.helloannie.com/api-reference/calls/start-outbound-call.md): Initiate an outbound call from an Annie phone number to a destination number. Calls are subject to legal hours (9 AM–8 PM org timezone) and per-number rate limits. Rate limits per destination number: max 6 calls per rolling 30 days, min 24 hours between attempts, 30-day cooldown after 3 consecutive…
- [Close conversation](https://docs.helloannie.com/api-reference/conversations/close-conversation.md): Close a conversation and run post-conversation actions including final summary, tagging, classification, notifications, and integrations. Calling this on a conversation that is already CLOSED returns 200 with status CLOSED (idempotent). Calling it on a conversation that is currently CLOSING (closure…
- [Create conversation](https://docs.helloannie.com/api-reference/conversations/create-conversation.md): Create a new conversation with the specified medium and bot. An anonymous user is automatically created for the conversation. Optionally seed the conversation with initial messages that will be attached in order.
- [Get conversation](https://docs.helloannie.com/api-reference/conversations/get-conversation.md): Return high-level information and summary for a specific conversation.
- [List conversation messages](https://docs.helloannie.com/api-reference/conversations/list-conversation-messages.md): Return all user and assistant messages for a conversation.
- [List conversations](https://docs.helloannie.com/api-reference/conversations/list-conversations.md): Return a paginated list of conversations. By default, returns conversations for the authenticated organization, sorted by creation date (newest first). Archived conversations are excluded by default. For account organizations, use `includeChildren=true` to include conversations from child organizati…
- [Create FAQ](https://docs.helloannie.com/api-reference/faqs/create-faq.md): Create a new FAQ for the organization. Optionally attach it to specific bots.
- [Delete FAQ](https://docs.helloannie.com/api-reference/faqs/delete-faq.md): Permanently delete an FAQ.
- [Get FAQ](https://docs.helloannie.com/api-reference/faqs/get-faq.md): Retrieve a single FAQ by ID.
- [List FAQs](https://docs.helloannie.com/api-reference/faqs/list-faqs.md): Returns all FAQs for the specified organization.
- [Update FAQ](https://docs.helloannie.com/api-reference/faqs/update-faq.md): Update an existing FAQ. Only provided fields will be updated.
- [Create Insurance](https://docs.helloannie.com/api-reference/insurances/create-insurance.md): Create a new insurance configuration for the organization. The insurance name is matched case-insensitively against known providers.
- [Delete Insurance](https://docs.helloannie.com/api-reference/insurances/delete-insurance.md): Permanently delete an insurance configuration.
- [Get Insurance](https://docs.helloannie.com/api-reference/insurances/get-insurance.md): Retrieve a single insurance configuration by ID.
- [List Insurances](https://docs.helloannie.com/api-reference/insurances/list-insurances.md): Returns all insurance configurations for the specified organization.
- [Update Insurance](https://docs.helloannie.com/api-reference/insurances/update-insurance.md): Update an existing insurance configuration. Only provided fields will be updated.
- [API Reference](https://docs.helloannie.com/api-reference/introduction.md): Complete API documentation for the Annie platform
- [List office hours](https://docs.helloannie.com/api-reference/office-hours/list-office-hours.md): Returns office hours for all days of the week. Days without configured hours are marked as closed. Optionally filter by a specific day using the dayOfWeek query parameter.
- [Set office hours](https://docs.helloannie.com/api-reference/office-hours/set-office-hours.md): Create or update office hours for a specific day of the week. Set isClosed to true to mark the office as closed on that day. When isClosed is false, open and close times are required.
- [Create organization](https://docs.helloannie.com/api-reference/organizations/create-organization.md): Create a new child organization. Only account organizations can create new organizations. The new organization will automatically be set as a child of the creating account organization. For security purposes, organizations can only be created using OAuth tokens for authorization.
- [Delete organization](https://docs.helloannie.com/api-reference/organizations/delete-organization.md): Permanently delete an organization. You cannot delete your own organization. If the organization has phone numbers, they will be reassigned to the parent organization. For security purposes, organizations can only be deleted using OAuth tokens for authorization.
- [Disable organization communications](https://docs.helloannie.com/api-reference/organizations/disable-organization-communications.md): Disable calls, chats, and SMS for an organization. Account organizations cannot be disabled.
- [Enable organization communications](https://docs.helloannie.com/api-reference/organizations/enable-organization-communications.md): Enable calls, chats, and SMS for an organization by restoring its verified phone webhook configuration.
- [Get organization](https://docs.helloannie.com/api-reference/organizations/get-organization.md): Fetch a single organization by ID that belongs to the authenticated principal.
- [List organizations](https://docs.helloannie.com/api-reference/organizations/list-organizations.md): Returns organizations for the authenticated principal. Account organizations can include child organizations with `includeChildren`.
- [Update organization](https://docs.helloannie.com/api-reference/organizations/update-organization.md): Modify mutable fields on an organization.For security purposes, organizations can only be updated using OAuth tokens for authorization.
- [Attach phone number to bot](https://docs.helloannie.com/api-reference/phone-numbers/attach-phone-number-to-bot.md): Attach a phone number to a bot. The bot must belong to the same organization as the phone number.
- [Create phone number](https://docs.helloannie.com/api-reference/phone-numbers/create-phone-number.md): Create a new phone number, associate it with an organization, and attach it to a bot.
- [Delete phone number](https://docs.helloannie.com/api-reference/phone-numbers/delete-phone-number.md): Delete a phone number. This action is irreversible. The phone number will be permanently removed.
- [Detach phone number from bot](https://docs.helloannie.com/api-reference/phone-numbers/detach-phone-number-from-bot.md): Detach a phone number from its currently attached bot. The phone number will remain in the same organization but will no longer be associated with any bot.
- [Get phone number](https://docs.helloannie.com/api-reference/phone-numbers/get-phone-number.md): Fetch a single phone number by ID that belongs to the authenticated organization.
- [List phone numbers](https://docs.helloannie.com/api-reference/phone-numbers/list-phone-numbers.md): Returns phone numbers accessible to the authenticated principal. For OAuth tokens, returns phone numbers for the parent organization and all child organizations. For API keys, returns only the authenticated organization's phone numbers. Use the `orgId` query parameter to filter results to a specific…
- [Migrate phone number to organization](https://docs.helloannie.com/api-reference/phone-numbers/migrate-phone-number-to-organization.md): Migrate a phone number to a different organization. The bot association will be cleared since the bot belongs to the source organization. You must have access to both the source and target organizations.
- [Update phone number configuration](https://docs.helloannie.com/api-reference/phone-numbers/update-phone-number-configuration.md): Update phone number configuration. Only provided fields will be updated. Updating language will also update the Millis agent configuration. If you want to update the botId, use the /attach endpoint instead. This is a deliberate design decision to prevent accidental changes to the associated bot.
- [Get conversation recording](https://docs.helloannie.com/api-reference/recordings/get-conversation-recording.md): Return a presigned URL to access the recording for a phone conversation. The URL is valid for 1 hour. Recordings are typically in WAV format, but some legacy recordings may be in MP3.
- [Create response](https://docs.helloannie.com/api-reference/responses/create-response.md): Send a user message to an existing conversation and receive a response from the bot associated with the conversation. The conversation must be in the OPEN state. CLOSED conversations return 400 Bad Request. CLOSING conversations return 409 Conflict. If the conversation has exceeded its non-resettabl…
- [Start outbound SMS conversation](https://docs.helloannie.com/api-reference/sms/start-outbound-sms-conversation.md): Initiate an outbound SMS conversation from an Annie phone number to a destination number. SMS is subject to legal hours (9 AM–8 PM org timezone) and per-number rate limits. Rate limits per destination number: max 6 SMS per rolling 30 days, min 24 hours between attempts, 30-day cooldown after 3 conse…
- [Apply template to bot](https://docs.helloannie.com/api-reference/templates/apply-template-to-bot.md): Apply a workflow template to a bot by providing values for all required variables. If the template has already been applied to this bot, the existing workflow will be replaced. Each variable can be provided in one of three ways: (1) an inline value (plain string or `{ value }`) that substitutes text…
- [Batch apply templates to bot](https://docs.helloannie.com/api-reference/templates/batch-apply-templates-to-bot.md): Apply multiple workflow templates to a bot in a single operation. All templates are validated upfront before processing. For each template, existing workflows from that template are deleted before reapplying. Returns a job ID to track progress.
- [Create template](https://docs.helloannie.com/api-reference/templates/create-template.md): Create a new workflow template with variable definitions
- [Delete template](https://docs.helloannie.com/api-reference/templates/delete-template.md): Delete a workflow template
- [Get batch job status](https://docs.helloannie.com/api-reference/templates/get-batch-job-status.md): Get the status and progress of a template batch apply job
- [Get template](https://docs.helloannie.com/api-reference/templates/get-template.md): Get a single template by ID, including the full workflow definition with placeholders
- [List templates](https://docs.helloannie.com/api-reference/templates/list-templates.md): List all workflow templates for the authenticated organization
- [Update template](https://docs.helloannie.com/api-reference/templates/update-template.md): Update an existing workflow template. All fields are optional. When the workflow definition changes, the template version is incremented.
- [Create variable](https://docs.helloannie.com/api-reference/variables/create-variable.md): Create a new variable for the specified organization.
- [Delete variable](https://docs.helloannie.com/api-reference/variables/delete-variable.md): Delete a variable. Fails if the variable is currently used in any workflows.
- [Get variable](https://docs.helloannie.com/api-reference/variables/get-variable.md): Fetch a single variable by ID for the specified organization.
- [List variables](https://docs.helloannie.com/api-reference/variables/list-variables.md): Returns all variables for the specified organization.
- [Update variable](https://docs.helloannie.com/api-reference/variables/update-variable.md): Update an existing variable for the specified organization.
- [Delete verified caller ID](https://docs.helloannie.com/api-reference/verified-caller-ids/delete-verified-caller-id.md): Remove a verified caller ID from Twilio and the database. Any phone numbers using this caller ID will have their verifiedCallerId cleared.
- [Get verified caller ID](https://docs.helloannie.com/api-reference/verified-caller-ids/get-verified-caller-id.md): Fetch a single verified caller ID by ID.
- [List verified caller IDs](https://docs.helloannie.com/api-reference/verified-caller-ids/list-verified-caller-ids.md): Returns verified caller IDs accessible to the authenticated principal. Use the `orgId` query parameter to filter results to a specific organization.
- [Start caller ID verification](https://docs.helloannie.com/api-reference/verified-caller-ids/start-caller-id-verification.md): Start the verification process for a phone number. Twilio will call the phone number and ask for a 6-digit validation code.
- [Create or update a workflow](https://docs.helloannie.com/api-reference/workflows/create-or-update-a-workflow.md): Create a new workflow or update an existing one. If an `id` is provided in the request body, the workflow will be updated; otherwise, a new workflow will be created.
- [Delete a workflow](https://docs.helloannie.com/api-reference/workflows/delete-a-workflow.md): Permanently delete a workflow and all its steps.
- [Export a single workflow](https://docs.helloannie.com/api-reference/workflows/export-a-single-workflow.md): Export a single workflow by ID in portable JSON format. The exported format can be used to import the workflow into other bots.
- [Export all workflows](https://docs.helloannie.com/api-reference/workflows/export-all-workflows.md): Export all workflows for a bot in portable JSON format. The exported format can be used to import workflows into other bots.
- [Authentication](https://docs.helloannie.com/overview/authentication.md): Set up API keys or OAuth to access the Annie API
- [Get Access](https://docs.helloannie.com/overview/get-access.md): Request API credentials and get set up with a sandbox environment
- [Bot Architecture](https://docs.helloannie.com/overview/guides/bots/architecture.md): Architecture patterns for multi-location practices and complex bot setups
- [Bot Configuration](https://docs.helloannie.com/overview/guides/bots/overview.md): Create and configure your AI agents
- [Website Chat Widget](https://docs.helloannie.com/overview/guides/deploying/chat-widget.md): Add Annie's chat widget to your website so visitors can chat with your AI assistant directly.
- [Receiving Inbound Calls](https://docs.helloannie.com/overview/guides/deploying/inbound-calls.md): Handle incoming calls with your Annie agent
- [Placing Outbound Calls](https://docs.helloannie.com/overview/guides/deploying/outbound-calls.md): Initiate calls from Annie to your patients
- [Deploying Annie](https://docs.helloannie.com/overview/guides/deploying/overview.md): Deploy your Annie agent to production
- [Setting Up a Phone Number](https://docs.helloannie.com/overview/guides/deploying/phone-numbers.md): A complete guide to provisioning, configuring, and attaching phone numbers to your Annie agent
- [Organizations](https://docs.helloannie.com/overview/guides/organizations/overview.md): Create and configure locations with addresses, hours, and staff
- [FAQs](https://docs.helloannie.com/overview/guides/training/faqs.md): Add training for specific questions with direct answers
- [Insurances](https://docs.helloannie.com/overview/guides/training/insurances.md): Configure insurance acceptance for accurate coverage responses
- [Training Overview](https://docs.helloannie.com/overview/guides/training/overview.md): Shape & control your agent's behavior
- [Templates](https://docs.helloannie.com/overview/guides/training/templates.md): Pre-built training packages for common use cases
- [Workflows](https://docs.helloannie.com/overview/guides/training/workflows.md): Define multi-step processes for complex interactions
- [Welcome to the Annie API](https://docs.helloannie.com/overview/introduction.md): Build custom agents that answer calls, schedule appointments, handle patient inquiries, and integrate with your existing systems, all without needing to manage the underlying AI infrastructure yourself.
- [Quickstart](https://docs.helloannie.com/overview/quickstart.md): Build your first agent in 5 steps

## OpenAPI Specs

- [openapi](https://docs.helloannie.com/openapi/openapi.yaml)