# Mindhunters API Documentation ## Docs - [Add a single guard rule](https://developers.mindhunters.ai/api-reference/agents/add-a-single-guard-rule.md) - [Add a single guideline](https://developers.mindhunters.ai/api-reference/agents/add-a-single-guideline.md) - [Add a single note](https://developers.mindhunters.ai/api-reference/agents/add-a-single-note.md) - [Add a single procedure (with optional steps)](https://developers.mindhunters.ai/api-reference/agents/add-a-single-procedure-with-optional-steps.md) - [Add a single routing rule](https://developers.mindhunters.ai/api-reference/agents/add-a-single-routing-rule.md) - [Add a single training data row](https://developers.mindhunters.ai/api-reference/agents/add-a-single-training-data-row.md) - [Add a webhook to this agent](https://developers.mindhunters.ai/api-reference/agents/add-a-webhook-to-this-agent.md): Returns 409 webhook_limit_reached if the agent already has 5 webhooks. - [Create an agent](https://developers.mindhunters.ai/api-reference/agents/create-an-agent.md): Creates the core agent. Optional sections such as settings, notes, guidelines, procedures, training, appointments, routing rules, and guard rules are stored when included. - [Create an intent](https://developers.mindhunters.ai/api-reference/agents/create-an-intent.md) - [Delete a single guard rule](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-guard-rule.md) - [Delete a single guideline](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-guideline.md) - [Delete a single note](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-note.md) - [Delete a single procedure (and its steps)](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-procedure-and-its-steps.md) - [Delete a single routing rule](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-routing-rule.md) - [Delete a single training row](https://developers.mindhunters.ai/api-reference/agents/delete-a-single-training-row.md) - [Delete a webhook](https://developers.mindhunters.ai/api-reference/agents/delete-a-webhook.md) - [Delete an intent](https://developers.mindhunters.ai/api-reference/agents/delete-an-intent.md) - [Get one agent](https://developers.mindhunters.ai/api-reference/agents/get-one-agent.md) - [Get one intent](https://developers.mindhunters.ai/api-reference/agents/get-one-intent.md) - [Get one webhook](https://developers.mindhunters.ai/api-reference/agents/get-one-webhook.md) - [List agents](https://developers.mindhunters.ai/api-reference/agents/list-agents.md) - [List intents for an agent](https://developers.mindhunters.ai/api-reference/agents/list-intents-for-an-agent.md) - [List webhooks for an agent](https://developers.mindhunters.ai/api-reference/agents/list-webhooks-for-an-agent.md): Returns the agent-scoped webhooks. Capped at 5 per agent. - [Provision call channel for an agent](https://developers.mindhunters.ai/api-reference/agents/provision-call-channel-for-an-agent.md): Runs provider-side telephony provisioning for a purchased phone number and connects it to the agent call channel. - [Replace agent appointment settings and schedule assignments](https://developers.mindhunters.ai/api-reference/agents/replace-agent-appointment-settings-and-schedule-assignments.md) - [Replace agent guard rules](https://developers.mindhunters.ai/api-reference/agents/replace-agent-guard-rules.md) - [Replace agent guidelines](https://developers.mindhunters.ai/api-reference/agents/replace-agent-guidelines.md) - [Replace agent notes](https://developers.mindhunters.ai/api-reference/agents/replace-agent-notes.md) - [Replace agent procedures](https://developers.mindhunters.ai/api-reference/agents/replace-agent-procedures.md) - [Replace agent routing rules](https://developers.mindhunters.ai/api-reference/agents/replace-agent-routing-rules.md) - [Replace agent training data](https://developers.mindhunters.ai/api-reference/agents/replace-agent-training-data.md) - [Replace/sync an agent](https://developers.mindhunters.ai/api-reference/agents/replacesync-an-agent.md): Same behavior as PATCH. Included collection sections replace that section for the agent. - [Soft-delete an agent](https://developers.mindhunters.ai/api-reference/agents/soft-delete-an-agent.md): Soft-deletes the agent. Child records (notes, guidelines, training, intents, etc.) remain in the database for recoverability but are no longer reachable via the API. Provider-side resources (Telnyx, WhatsApp etc.) are NOT torn down — release/unbind phone numbers separately first. - [Update a single guard rule](https://developers.mindhunters.ai/api-reference/agents/update-a-single-guard-rule.md) - [Update a single guideline](https://developers.mindhunters.ai/api-reference/agents/update-a-single-guideline.md) - [Update a single note](https://developers.mindhunters.ai/api-reference/agents/update-a-single-note.md) - [Update a single procedure (and replace its steps if provided)](https://developers.mindhunters.ai/api-reference/agents/update-a-single-procedure-and-replace-its-steps-if-provided.md): Updates the procedure name/description. If a steps array is included, it replaces the procedure's existing steps. - [Update a single routing rule](https://developers.mindhunters.ai/api-reference/agents/update-a-single-routing-rule.md) - [Update a single training row](https://developers.mindhunters.ai/api-reference/agents/update-a-single-training-row.md) - [Update a webhook](https://developers.mindhunters.ai/api-reference/agents/update-a-webhook.md) - [Update an agent](https://developers.mindhunters.ai/api-reference/agents/update-an-agent.md): Updates core fields and settings. If collection sections are included, they replace that section for the agent. - [Update an intent](https://developers.mindhunters.ai/api-reference/agents/update-an-intent.md): Updates intent fields. If 'parameters' is included, it replaces the parameter list. - [Cancel an appointment request](https://developers.mindhunters.ai/api-reference/appointment-requests/cancel-an-appointment-request.md): Cancels a pending appointment request. Only requests with 'pending' status can be cancelled. - [Create a new appointment request](https://developers.mindhunters.ai/api-reference/appointment-requests/create-a-new-appointment-request.md): Creates a new appointment request. You can either provide an existing contact_id or contact details to create/find a contact automatically. - [Get a specific appointment request](https://developers.mindhunters.ai/api-reference/appointment-requests/get-a-specific-appointment-request.md): Retrieves details of a specific appointment request by UUID. - [Get available time slots for a schedule](https://developers.mindhunters.ai/api-reference/appointment-requests/get-available-time-slots-for-a-schedule.md): Returns available time slots for a specific schedule on a given date. This is a placeholder endpoint that needs implementation based on schedule working hours and existing appointments. - [Get list of appointment requests](https://developers.mindhunters.ai/api-reference/appointment-requests/get-list-of-appointment-requests.md): Retrieves a list of appointment requests with optional filtering by status, schedule, and date range. - [Create a new appointment](https://developers.mindhunters.ai/api-reference/appointments/create-a-new-appointment.md) - [Delete an appointment](https://developers.mindhunters.ai/api-reference/appointments/delete-an-appointment.md) - [Get a specific appointment](https://developers.mindhunters.ai/api-reference/appointments/get-a-specific-appointment.md) - [Get all appointments (calendar)](https://developers.mindhunters.ai/api-reference/appointments/get-all-appointments-calendar.md) - [Update an appointment](https://developers.mindhunters.ai/api-reference/appointments/update-an-appointment.md) - [Update appointment status](https://developers.mindhunters.ai/api-reference/appointments/update-appointment-status.md) - [Create a new availability type](https://developers.mindhunters.ai/api-reference/availability-types/create-a-new-availability-type.md) - [Delete an availability type](https://developers.mindhunters.ai/api-reference/availability-types/delete-an-availability-type.md) - [Get a specific availability type](https://developers.mindhunters.ai/api-reference/availability-types/get-a-specific-availability-type.md) - [Get all availability types](https://developers.mindhunters.ai/api-reference/availability-types/get-all-availability-types.md) - [Update an availability type](https://developers.mindhunters.ai/api-reference/availability-types/update-an-availability-type.md) - [Get call details by UUID](https://developers.mindhunters.ai/api-reference/call/get-call-details-by-uuid.md): Retrieves detailed information about a specific call by its UUID. - [Get paginated list of calls](https://developers.mindhunters.ai/api-reference/call/get-paginated-list-of-calls.md): Retrieves a paginated list of calls with optional filtering. - [Initiate a new call](https://developers.mindhunters.ai/api-reference/call/initiate-a-new-call.md): Initiates a call if the specified agent exists, has valid call settings, and the participant's phone number is provided. The call can include a custom greeting message, a prompt to guide the agent, and optional details about the participant. This endpoint is used to trigger outbound calls with speci… - [Create a new campaign](https://developers.mindhunters.ai/api-reference/campaigns/create-a-new-campaign.md): Creates a new campaign with the provided information. - [Delete a campaign](https://developers.mindhunters.ai/api-reference/campaigns/delete-a-campaign.md): Soft deletes a campaign by its UUID. - [Get campaign details](https://developers.mindhunters.ai/api-reference/campaigns/get-campaign-details.md): Retrieves detailed information about a specific campaign. - [Get paginated list of campaigns](https://developers.mindhunters.ai/api-reference/campaigns/get-paginated-list-of-campaigns.md): Retrieves a paginated list of campaigns with optional filtering. - [Update a campaign](https://developers.mindhunters.ai/api-reference/campaigns/update-a-campaign.md): Updates an existing campaign with the provided information. - [Add tag to contact](https://developers.mindhunters.ai/api-reference/contacts/add-tag-to-contact.md): Adds a tag to a specific contact. - [Create a new contact](https://developers.mindhunters.ai/api-reference/contacts/create-a-new-contact.md): Creates a new contact with the provided information. - [Delete a contact](https://developers.mindhunters.ai/api-reference/contacts/delete-a-contact.md): Soft deletes a contact by its UUID. - [Get contact details](https://developers.mindhunters.ai/api-reference/contacts/get-contact-details.md): Retrieves detailed information about a specific contact. - [Get paginated list of contacts](https://developers.mindhunters.ai/api-reference/contacts/get-paginated-list-of-contacts.md): Retrieves a paginated list of contacts with optional filtering. - [Remove tag from contact](https://developers.mindhunters.ai/api-reference/contacts/remove-tag-from-contact.md): Removes a tag from a specific contact. - [Update a contact](https://developers.mindhunters.ai/api-reference/contacts/update-a-contact.md): Updates an existing contact with the provided information. - [Get conversation details](https://developers.mindhunters.ai/api-reference/conversations/get-conversation-details.md) - [Get paginated list of conversations](https://developers.mindhunters.ai/api-reference/conversations/get-paginated-list-of-conversations.md): Retrieves a paginated list of conversations with optional filtering by phone, contact, channel and agent. - [Get paginated messages of a conversation](https://developers.mindhunters.ai/api-reference/conversations/get-paginated-messages-of-a-conversation.md): Returns paginated messages (AI + Human + Contact) for a given conversation UUID. - [Assign imported data to an agent](https://developers.mindhunters.ai/api-reference/dataimport/assign-imported-data-to-an-agent.md): Associates imported data with an agent and triggers an async sync. - [Create a record for imported data](https://developers.mindhunters.ai/api-reference/dataimport/create-a-record-for-imported-data.md): Creates a new record with values for the specified knowledge base. Provide either a values array (with column_id or column_name) or a record object keyed by field names. - [Delete a record](https://developers.mindhunters.ai/api-reference/dataimport/delete-a-record.md): Deletes a record and its values from the specified knowledge base. - [Delete imported data](https://developers.mindhunters.ai/api-reference/dataimport/delete-imported-data.md): Deletes imported data by UUID (soft delete). - [Get all imported data](https://developers.mindhunters.ai/api-reference/dataimport/get-all-imported-data.md): Retrieves a list of all imported data. - [Get data details by UUID](https://developers.mindhunters.ai/api-reference/dataimport/get-data-details-by-uuid.md): Retrieves detailed information about specific imported data. - [Get fields (columns) for imported data](https://developers.mindhunters.ai/api-reference/dataimport/get-fields-columns-for-imported-data.md): Returns the list of fields associated with a knowledge base. - [Get records for imported data](https://developers.mindhunters.ai/api-reference/dataimport/get-records-for-imported-data.md): Returns records with their field values using pagination. - [Import data from a website URL](https://developers.mindhunters.ai/api-reference/dataimport/import-data-from-a-website-url.md): Crawls and imports data from a provided website URL (up to 3 layers deep). - [Import data via copy-paste text](https://developers.mindhunters.ai/api-reference/dataimport/import-data-via-copy-paste-text.md): Imports data by processing text that has been copy-pasted. - [Import data via file upload](https://developers.mindhunters.ai/api-reference/dataimport/import-data-via-file-upload.md): Imports data from an uploaded file (CSV, Excel, JSON, PDF, XML, or Audio up to 128MB). - [Trigger a sync for data across all associated agents](https://developers.mindhunters.ai/api-reference/dataimport/trigger-a-sync-for-data-across-all-associated-agents.md): Resets agent-data statuses to pending and dispatches sync jobs for each associated agent. - [Update record values](https://developers.mindhunters.ai/api-reference/dataimport/update-record-values.md): Updates one or more values for a specific record. Provide either a values array (with column_id or column_name) or a record object keyed by field names. - [Get a single evaluation](https://developers.mindhunters.ai/api-reference/evaluations/get-a-single-evaluation.md) - [Get paginated list of session evaluations](https://developers.mindhunters.ai/api-reference/evaluations/get-paginated-list-of-session-evaluations.md): Retrieves a paginated list of session evaluations with optional filtering by session/conversation/contact UUID and creation date range. - [Introduction](https://developers.mindhunters.ai/api-reference/introduction.md): Complete API reference for the Mindhunters platform - [Add contacts to an existing listing](https://developers.mindhunters.ai/api-reference/listings/add-contacts-to-an-existing-listing.md) - [Create a new listing with rule and bulk contacts](https://developers.mindhunters.ai/api-reference/listings/create-a-new-listing-with-rule-and-bulk-contacts.md) - [Delete a listing](https://developers.mindhunters.ai/api-reference/listings/delete-a-listing.md) - [Get all listings (campaigns with pools)](https://developers.mindhunters.ai/api-reference/listings/get-all-listings-campaigns-with-pools.md) - [Get listing details with contacts](https://developers.mindhunters.ai/api-reference/listings/get-listing-details-with-contacts.md) - [Remove a contact from a listing and cancel their tasks](https://developers.mindhunters.ai/api-reference/listings/remove-a-contact-from-a-listing-and-cancel-their-tasks.md) - [Start/resume a listing campaign](https://developers.mindhunters.ai/api-reference/listings/startresume-a-listing-campaign.md) - [Stop/pause a running listing campaign](https://developers.mindhunters.ai/api-reference/listings/stoppause-a-running-listing-campaign.md) - [Assign a number to an agent](https://developers.mindhunters.ai/api-reference/phone-numbers/assign-a-number-to-an-agent.md): Connects this number to one of your agents on a specific channel (call, SMS, or WhatsApp). The agent must already have that channel configured. A number can only serve one agent per channel — disconnect the existing assignment first if you're switching. - [Channels for a phone number (look up by number)](https://developers.mindhunters.ai/api-reference/phone-numbers/channels-for-a-phone-number-look-up-by-number.md): Same as the by-UUID version, but you only need the phone number itself. Works for both owned numbers and external ones (numbers your agents use but didn't buy through us). The leading + is optional. - [Channels for one phone number](https://developers.mindhunters.ai/api-reference/phone-numbers/channels-for-one-phone-number.md): A trimmed-down view focused on what each channel (call, SMS, WhatsApp, inbound) can do for this number: what it supports, whether it's enabled, and which agent it's connected to. - [Compliance requirements for a country](https://developers.mindhunters.ai/api-reference/phone-numbers/compliance-requirements-for-a-country.md): Some countries require documents (proof of ID, business license, local address) before a number can be activated. Use this to find out exactly what's needed for the country and number type you're targeting, so you can prepare them before purchase. - [Get one phone number](https://developers.mindhunters.ai/api-reference/phone-numbers/get-one-phone-number.md): Returns full details for a single number — capabilities, channel settings, billing, compliance status, and which agents are using it on each channel. - [List your phone numbers](https://developers.mindhunters.ai/api-reference/phone-numbers/list-your-phone-numbers.md): Returns the phone numbers you've purchased, with each number's current settings, capabilities, and which agents are using it. Set include_external=true to also see numbers your agents use that weren't bought through us (for example, a WhatsApp Business line). - [Outbound call rates](https://developers.mindhunters.ai/api-reference/phone-numbers/outbound-call-rates.md): Per-minute pricing for outbound calls, broken down by destination country and prefix. Useful for estimating campaign costs before you launch. - [Phone number summary](https://developers.mindhunters.ai/api-reference/phone-numbers/phone-number-summary.md): A quick snapshot for dashboards: how many numbers you have, how many need attention (e.g. compliance pending), your total monthly spend, and breakdowns by country and number type. - [Release a phone number](https://developers.mindhunters.ai/api-reference/phone-numbers/release-a-phone-number.md): Removes a number from your active inventory. If any agent is still using the number on call, SMS, or WhatsApp, the request is rejected — disconnect those agents first. - [Release a phone number](https://developers.mindhunters.ai/api-reference/phone-numbers/release-a-phone-number-1.md): Action-style alias for DELETE /api/v1/phone-numbers/{uuid}. Soft-deletes a number after checking that it has no active agent bindings. - [Remove a number from an agent](https://developers.mindhunters.ai/api-reference/phone-numbers/remove-a-number-from-an-agent.md): Disconnects this number from whichever agent currently uses it on the given channel. The number stays in your inventory and is free to reassign. - [Search numbers available to buy](https://developers.mindhunters.ai/api-reference/phone-numbers/search-numbers-available-to-buy.md): Browse phone numbers available for purchase in a given country. You can filter by type (local, toll-free, mobile, national), area code, or pattern. Results include pricing and whether compliance steps will be required before activation. - [Update channel settings](https://developers.mindhunters.ai/api-reference/phone-numbers/update-channel-settings.md): Turn voice, SMS, or inbound on or off, set per-channel concurrency limits, and choose which destination countries are allowed for outbound traffic. Channels can't be turned on while compliance is still pending for the number. - [Which agents use which numbers](https://developers.mindhunters.ai/api-reference/phone-numbers/which-agents-use-which-numbers.md): A summary of every active phone number and the agents using it, grouped by channel. Includes both numbers you've purchased and external ones (e.g. WhatsApp Business). Powers the 'Used Channels & Accounts' dashboard. - [Create a new schedule](https://developers.mindhunters.ai/api-reference/schedules/create-a-new-schedule.md) - [Delete a schedule](https://developers.mindhunters.ai/api-reference/schedules/delete-a-schedule.md) - [Get a specific schedule](https://developers.mindhunters.ai/api-reference/schedules/get-a-specific-schedule.md) - [Get all schedules](https://developers.mindhunters.ai/api-reference/schedules/get-all-schedules.md) - [Update a schedule](https://developers.mindhunters.ai/api-reference/schedules/update-a-schedule.md) - [Get paginated list of conversation sessions](https://developers.mindhunters.ai/api-reference/sessions/get-paginated-list-of-conversation-sessions.md): Retrieves a paginated list of sessions with optional filtering by conversation, contact, agent, status and type. - [Get paginated messages of a session](https://developers.mindhunters.ai/api-reference/sessions/get-paginated-messages-of-a-session.md): Returns paginated messages (AI + Human + Contact) linked to this session via the conversation_session_messages pivot. - [Get paginated sessions of a conversation](https://developers.mindhunters.ai/api-reference/sessions/get-paginated-sessions-of-a-conversation.md) - [Get session details](https://developers.mindhunters.ai/api-reference/sessions/get-session-details.md) - [Get the evaluation of a session](https://developers.mindhunters.ai/api-reference/sessions/get-the-evaluation-of-a-session.md): Returns the evaluation record for the session if one exists. Each dimension contains value/confidence/reason. - [Send an SMS message](https://developers.mindhunters.ai/api-reference/sms/send-an-sms-message.md): Sends an SMS message to a phone number using the specified agent's SMS configuration. The agent must have an SMS channel configured with a valid phone number and messaging profile. - [Cancel a task](https://developers.mindhunters.ai/api-reference/tasks/cancel-a-task.md): Cancels a pending, scheduled, or queued task - [Create a new task (Call or WhatsApp Template)](https://developers.mindhunters.ai/api-reference/tasks/create-a-new-task-call-or-whatsapp-template.md): Creates a new task for making calls or sending WhatsApp templates. Supports automatic contact lookup/creation by phone or email. See examples below for both types. - [Delete a task](https://developers.mindhunters.ai/api-reference/tasks/delete-a-task.md): Soft deletes a task. Tasks in progress or queued will be cancelled first. - [Get a specific task](https://developers.mindhunters.ai/api-reference/tasks/get-a-specific-task.md): Retrieves details of a specific task by UUID - [Get paginated list of tasks](https://developers.mindhunters.ai/api-reference/tasks/get-paginated-list-of-tasks.md): Retrieves a paginated list of tasks with optional filtering - [Queue a task for execution](https://developers.mindhunters.ai/api-reference/tasks/queue-a-task-for-execution.md): Manually queues a scheduled task for immediate or delayed execution - [Retry a failed task](https://developers.mindhunters.ai/api-reference/tasks/retry-a-failed-task.md): Retries a failed task if max attempts not reached - [Update a task](https://developers.mindhunters.ai/api-reference/tasks/update-a-task.md): Updates an existing task. Will re-queue if status or schedule changes - [Create a new transcription request](https://developers.mindhunters.ai/api-reference/transcriptions/create-a-new-transcription-request.md): Creates a new transcription request. Either a voice file upload or voice URL must be provided. If webhook_url is provided, a POST request will be sent to that URL when processing is complete. The webhook will receive: {id, reference_id, status, conversation: {id}, session: {id, type, status}, transc… - [Get full transcript with conversation messages and evaluations](https://developers.mindhunters.ai/api-reference/transcriptions/get-full-transcript-with-conversation-messages-and-evaluations.md): Retrieves the complete transcript including conversation messages (role/content format), full text, and AI evaluations. Returns the same data structure sent to webhooks. - [Get transcription by UUID](https://developers.mindhunters.ai/api-reference/transcriptions/get-transcription-by-uuid.md): Retrieves a transcription's details and results by its UUID. - [Make a WhatsApp call](https://developers.mindhunters.ai/api-reference/whatsapp-calling/make-a-whatsapp-call.md): Initiate a WhatsApp voice call to a contact. Requires call permission from the contact. - [Send call permission request](https://developers.mindhunters.ai/api-reference/whatsapp-calling/send-call-permission-request.md): Send a call permission request to a WhatsApp contact. The contact will receive an interactive message to accept or reject. Max 1 request per day, 2 per week per contact. - [Send WhatsApp template message](https://developers.mindhunters.ai/api-reference/whatsapp/send-whatsapp-template-message.md): Sends a WhatsApp template message to a specified phone number using an agent's configured WhatsApp Business API. The template must be pre-approved by WhatsApp and the agent must have WhatsApp channel configured. - [Authentication](https://developers.mindhunters.ai/authentication.md): Learn how to authenticate your API requests with Mindhunters - [Error Handling](https://developers.mindhunters.ai/errors.md): Understand error codes, responses, and troubleshooting strategies for the Mindhunters API - [Campaign Management](https://developers.mindhunters.ai/guides/services/campaigns.md): Create and manage multi-channel communication campaigns - [Contact Management](https://developers.mindhunters.ai/guides/services/contacts.md): Organize and manage your contact database with custom fields and segmentation - [Services Overview](https://developers.mindhunters.ai/guides/services/overview.md): Overview of Mindhunters platform services and capabilities - [AI Voice Agents](https://developers.mindhunters.ai/guides/services/voice-agents.md): Create and manage intelligent AI voice agents for automated phone conversations - [WhatsApp Messaging](https://developers.mindhunters.ai/guides/services/whatsapp.md): Send automated WhatsApp messages using pre-approved templates - [Introduction](https://developers.mindhunters.ai/introduction.md): Welcome to Mindhunters API Documentation - Build powerful AI-driven voice and text conversations - [Monitoring & Logs](https://developers.mindhunters.ai/monitoring.md): Track your API requests, responses, and webhook deliveries in real-time - [Quickstart](https://developers.mindhunters.ai/quickstart.md): Get started with the Mindhunters API in minutes - make your first call - [Webhooks](https://developers.mindhunters.ai/webhooks.md): Receive real-time notifications about events in your Mindhunters workspace ## OpenAPI Specs - [api-docs](https://app.mindhunters.ai/docs/api-docs.json) ## Optional - [Mindhunters](https://mindhunters.ai) - [Login](https://app.mindhunters.ai)