# NLPearl Documentation

## Docs

- [Quick Start](https://developers.nlpearl.ai/api-reference/api_quickstart.md): Get started with the NLPearl.AI API by following these simple steps to set up your subscription, API secret key, and authentication.
- [API Authorization](https://developers.nlpearl.ai/api-reference/authorization.md): Learn how to authenticate your API requests using your Account ID and API secret key.
- [Pearl Flow Variables Guidance](https://developers.nlpearl.ai/api-reference/flow_variables.md)
- [Python Wrapper](https://developers.nlpearl.ai/api-reference/python_wrapper.md): Learn how to use the NLPearl Python wrapper to interact with the NLPearl API effortlessly.
- [Get Account](https://developers.nlpearl.ai/api-reference/v1/account/get-account.md): Retrieves account details
- [Delete Calls](https://developers.nlpearl.ai/api-reference/v1/call/delete-call.md): Deletes one or more calls
- [Get Call](https://developers.nlpearl.ai/api-reference/v1/call/get-call.md): Retrieves all the information about a call
- [Get Analytics](https://developers.nlpearl.ai/api-reference/v1/inbound/get-analytics.md): Retrieves analytics data for a specific inbound campaign within a given date range.
- [Get Inbound](https://developers.nlpearl.ai/api-reference/v1/inbound/get-inbound.md): Retrieves a specific inbound by its ID
- [Get Inbound Ongoing Calls](https://developers.nlpearl.ai/api-reference/v1/inbound/get-inbound-ongoing-calls.md): Returns the number of active calls currently in progress and in queue for the specified inbound ID.
- [Get Inbounds](https://developers.nlpearl.ai/api-reference/v1/inbound/get-inbounds.md): Retrieves all inbounds
- [Search Calls](https://developers.nlpearl.ai/api-reference/v1/inbound/search-calls.md): Retrieves the calls within a specific date range of inbound
- [Set Activity State](https://developers.nlpearl.ai/api-reference/v1/inbound/set-activity-state.md): Run or Pause a specific inbound
- [Add Lead](https://developers.nlpearl.ai/api-reference/v1/outbound/add-lead.md): Adds a new lead to a specified outbound
- [Delete Leads](https://developers.nlpearl.ai/api-reference/v1/outbound/delete-leads.md): Deletes one or more leads associated with a specific outbound campaign.
- [Delete leads Via External](https://developers.nlpearl.ai/api-reference/v1/outbound/delete-leads-external-id.md): Deletes one or more leads associated with a specific outbound campaign.
- [Get Analytics](https://developers.nlpearl.ai/api-reference/v1/outbound/get-analytics.md): Retrieves analytics data for a specific outbound campaign within a given date range.
- [Get Call Request](https://developers.nlpearl.ai/api-reference/v1/outbound/get-call-request.md): Fetches detailed information about a specific API request identified by its unique requestId.
- [Get Lead](https://developers.nlpearl.ai/api-reference/v1/outbound/get-lead.md): Retrieves details of a specific lead within a outbound
- [Get Lead via External ID](https://developers.nlpearl.ai/api-reference/v1/outbound/get-lead-via-external-id.md): Retrieves details of a specific lead within an outbound
- [Get Lead via Phone Number](https://developers.nlpearl.ai/api-reference/v1/outbound/get-lead-via-phone-number.md): Retrieves details of a specific lead within an outbound via phone number
- [Get Outbound](https://developers.nlpearl.ai/api-reference/v1/outbound/get-outbound.md): Retrieve a specific outbound by its ID
- [Get Outbounds](https://developers.nlpearl.ai/api-reference/v1/outbound/get-outbounds.md): Retreive all the Outbounds
- [Make Call](https://developers.nlpearl.ai/api-reference/v1/outbound/make-call.md): Initiates an outbound phone call associated with the specified outbound ID. The request body must contain the necessary details for making the call. Once initiated, the call will be routed to the first available agent.
- [Search Call Requests](https://developers.nlpearl.ai/api-reference/v1/outbound/search-call-requests.md): Fetches a list of API call requests associated with a specific outbound identifier. The search criteria, such as filters or pagination options, should be provided in the request body.
- [Search Calls](https://developers.nlpearl.ai/api-reference/v1/outbound/search-calls.md): Retrieves the calls within a specific date range for a given outbound
- [Search Leads](https://developers.nlpearl.ai/api-reference/v1/outbound/search-leads.md): Retrieves the leads associated with a specific outbound
- [Set Activity State](https://developers.nlpearl.ai/api-reference/v1/outbound/set-activity-state.md): Activates or deactivates a specified outbound
- [Update Lead](https://developers.nlpearl.ai/api-reference/v1/outbound/update-lead.md): Updates the details of an existing lead associated with a specific outbound campaign.
- [Reset Customer Memory](https://developers.nlpearl.ai/api-reference/v1/pearl/reset-memory.md): Resets stored memory associated with a specific customer's phone number for a given Pearl.
- [Add Phone Numbers To Blacklist](https://developers.nlpearl.ai/api-reference/v2/account/add-to-blacklist.md): Adds one or more phone numbers to the account blacklist.
- [Get Account](https://developers.nlpearl.ai/api-reference/v2/account/get-account.md): Retrieves account details
- [Get Users](https://developers.nlpearl.ai/api-reference/v2/account/get-account-users.md): Retrieves the list of users for the account
- [Get Audit Log](https://developers.nlpearl.ai/api-reference/v2/account/get-audit-log.md): Retrieves the audit log.
- [Remove Phone Numbers From Blacklist](https://developers.nlpearl.ai/api-reference/v2/account/remove-from-blacklist.md): Removes one or more phone numbers from the account blacklist.
- [Search Blacklist](https://developers.nlpearl.ai/api-reference/v2/account/search-blacklist.md): Retrieves the paginated blacklist phone numbers of the account.
- [Delete Calls](https://developers.nlpearl.ai/api-reference/v2/call/delete-call.md): Deletes one or more calls
- [Get Call](https://developers.nlpearl.ai/api-reference/v2/call/get-call.md): Retrieves all the information about a call
- [Add Lead](https://developers.nlpearl.ai/api-reference/v2/outbound/add-lead.md): Adds a new lead to a specified outbound
- [Add Leads](https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads.md): Adds new leads to a specified outbound
- [Delete Leads](https://developers.nlpearl.ai/api-reference/v2/outbound/delete-leads.md): Deletes one or more leads associated with a specific outbound campaign.
- [Delete leads Via External](https://developers.nlpearl.ai/api-reference/v2/outbound/delete-leads-external-id.md): Deletes one or more leads associated with a specific outbound campaign.
- [Get Lead](https://developers.nlpearl.ai/api-reference/v2/outbound/get-lead.md): Retrieves details of a specific lead within a outbound
- [Get Lead Via External ID](https://developers.nlpearl.ai/api-reference/v2/outbound/get-lead-via-external-id.md): Retrieves details of a specific lead within an outbound
- [Find Lead Via Phone Number](https://developers.nlpearl.ai/api-reference/v2/outbound/get-lead-via-phone-number.md): Retrieves details of a specific lead within an outbound via phone number
- [Search Leads](https://developers.nlpearl.ai/api-reference/v2/outbound/search-leads.md): Retrieves the leads associated with a specific outbound
- [Update Lead](https://developers.nlpearl.ai/api-reference/v2/outbound/update-lead.md): Updates the details of an existing lead associated with a specific outbound campaign.
- [Get analytics](https://developers.nlpearl.ai/api-reference/v2/pearl/get-analytics.md)
- [Get Calls](https://developers.nlpearl.ai/api-reference/v2/pearl/get-calls.md): Retrieves the calls within a specific date range of a pearl
- [Get Ongoing Calls](https://developers.nlpearl.ai/api-reference/v2/pearl/get-ongoing-calls.md): Returns the number of active calls currently in progress for the specified Pearl. If the Pearl has inbound configurations, it also returns the number of calls currently in queue.
- [Get Pearl](https://developers.nlpearl.ai/api-reference/v2/pearl/get-pearl.md): Retrieves a specific Pearl by its ID
- [Get Pearls](https://developers.nlpearl.ai/api-reference/v2/pearl/get-pearls.md): Retrieves all Pearls
- [Reset Customer Memory](https://developers.nlpearl.ai/api-reference/v2/pearl/reset-memory.md): Resets stored memory associated with a specific customer's phone number for a given Pearl.
- [Set Activity State](https://developers.nlpearl.ai/api-reference/v2/pearl/set-activity-state.md): Run or Pause a specific Pearl
- [Create Pearl](https://developers.nlpearl.ai/api-reference/v2/pearlFlow/add-pearl-flow.md): Creates a new Pearl
- [Get Pearl Settings](https://developers.nlpearl.ai/api-reference/v2/pearlFlow/get-pearl-flow.md): Retrieves the Settings for the specified Pearl. The Pearl and Variables sections in the response are populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, these fields will be returned empty.
- [Update Pearl](https://developers.nlpearl.ai/api-reference/v2/pearlFlow/update-pearl-flow.md): Updates the settings for the specified Pearl.
- [Update Inbound Settings](https://developers.nlpearl.ai/api-reference/v2/pearlFlow/update-pearl-inbound.md): Updates the inbound settings for the specified Pearl.
- [Update Outbound Settings](https://developers.nlpearl.ai/api-reference/v2/pearlFlow/update-pearl-outbound.md): Updates the outbound settings for the specified Pearl.
- [Get Phone Numbers](https://developers.nlpearl.ai/api-reference/v2/pearlSettings/get-phones.md): Retrieves all active phone numbers of the account.
- [Get Voices](https://developers.nlpearl.ai/api-reference/v2/pearlSettings/get-voices.md): Retrieves the available voices grouped by language.
- [Overview](https://developers.nlpearl.ai/pages/action.md): NLPearl.AI provides a range of actions that can be performed by your Pearl both during and after calls. These actions are designed to automate tasks, improve efficiency, and enhance customer interactions.
- [Agents](https://developers.nlpearl.ai/pages/agents.md): Agents are your capacity to handle voice calls and text conversations in NLPearl. Learn how they work and how to manage them.
- [Call Analytics](https://developers.nlpearl.ai/pages/analytics.md): NLPearl provides detailed analytics for every campaign, helping you track performance, understand Pearl's activity, and optimize your strategy in real time.
- [API Action](https://developers.nlpearl.ai/pages/api_action.md): Configure the “API” action in SimplePearl and AdvancedPearl to fetch or update data during a live conversation.
- [Billing](https://developers.nlpearl.ai/pages/billing.md): Learn how to manage your billing settings, subscriptions, and invoices on the NLPearl.AI platform.
- [Phone Number Blacklist](https://developers.nlpearl.ai/pages/blacklist.md)
- [Custom VoIP Integration](https://developers.nlpearl.ai/pages/custom_voip.md): Learn how to integrate your own VoIP service with NLPearl.AI.
- [Send An Email](https://developers.nlpearl.ai/pages/email_action.md): Learn how to configure the "Send An Email" action within a Pearl, allowing your AI agent to send emails during a conversation.
- [Getting Started](https://developers.nlpearl.ai/pages/getting_started.md): Go from sign-up to your first live AI agent in minutes.
- [Inbound](https://developers.nlpearl.ai/pages/inbound.md): Learn how to set up Inbound Activities using your created Pearl to handle incoming calls effectively.
- [Welcome to NLPearl](https://developers.nlpearl.ai/pages/introduction.md): Build and deploy AI agents - voice agents that handle real phone conversations in 20+ languages, and text agents across SMS, WhatsApp, email, and chat - all by simply chatting with AI.
- [Voices and Languages](https://developers.nlpearl.ai/pages/languages.md): At NLPearl, we offer a wide variety of languages and accents to cater to a global audience. You can configure your Pearl to handle conversations in multiple languages, providing a seamless and personalized experience for your users.
- [NLPearl Phone Numbers](https://developers.nlpearl.ai/pages/nlpearl_phones.md): Learn how to purchase phone numbers directly from the NLPearl.AI platform.
- [Outbound](https://developers.nlpearl.ai/pages/outbound.md): Learn how to set up and manage Outbound Campaigns using NLPearl.AI to handle outbound calls effectively.
- [Payouts](https://developers.nlpearl.ai/pages/payout.md): Earn real money by sharing your Pearls with the NLPearl community.
- [PearlVibe](https://developers.nlpearl.ai/pages/pearl_vibe.md)
- [Pearl Voice](https://developers.nlpearl.ai/pages/pearl_voice.md): Build AI voice agents that handle real, natural phone conversations - inbound and outbound - in 20+ languages.
- [Phone Numbers Overview](https://developers.nlpearl.ai/pages/phone_overview.md): Learn why phone numbers are essential for activities on NLPearl.AI and the available options for purchasing and integrating them.
- [Post-Call](https://developers.nlpearl.ai/pages/postcall.md): All you need to know about Post-Call in NLPearl
- [Account Security Settings](https://developers.nlpearl.ai/pages/security.md): Manage session timeout, audit logs, two-factor authentication, and enterprise access controls.
- [Send SMS](https://developers.nlpearl.ai/pages/sms_action.md): Learn how to configure the "Send SMS" action within a Pearl, allowing your AI agent to send SMS messages during a conversation.
- [API Action](https://developers.nlpearl.ai/pages/text/api_action.md): Configure API actions in PearlVibe to fetch or update data during a live conversation.
- [Send An Email](https://developers.nlpearl.ai/pages/text/email_action.md): Learn how to configure the "Send An Email" action within a Pearl, allowing your AI agent to send emails during a conversation.
- [Hand-Off](https://developers.nlpearl.ai/pages/text/handoff_action.md): Hand the conversation off to a human agent, with an optional message from Pearl and notifications to your team.
- [Inbound](https://developers.nlpearl.ai/pages/text/inbound.md): Learn how to set up Inbound Activities using your created Pearl to handle incoming conversations effectively.
- [Outbound](https://developers.nlpearl.ai/pages/text/outbound.md): Learn how to set up and manage Outbound Campaigns using NLPearl.AI to handle outbound conversations effectively.
- [Pearl Text](https://developers.nlpearl.ai/pages/text/pearl_text.md): Build AI text agents that message your customers across SMS, WhatsApp, email, and chat - on inbound and outbound conversations.
- [Post-Chat](https://developers.nlpearl.ai/pages/text/postchat.md): All you need to know about Post-Chat in NLPearl
- [Transfer Call](https://developers.nlpearl.ai/pages/transfer_call.md): Learn how to use the Transfer Call action in NLPearl.AI to seamlessly redirect calls during a conversation.
- [Twilio Integration](https://developers.nlpearl.ai/pages/twilio_integration.md): Learn how to integrate your Twilio account with NLPearl.AI and use your Twilio phone numbers.
- [Users & Workspaces](https://developers.nlpearl.ai/pages/users_workspaces.md): Invite users, assign roles, manage permissions, and switch between workspaces.
- [Variables](https://developers.nlpearl.ai/pages/variables.md)
- [Webhooks](https://developers.nlpearl.ai/pages/webhooks.md): Understand the webhook payloads sent by NLPearl.AI for lead and call events in real time.

## OpenAPI Specs

- [openapiV2](https://developers.nlpearl.ai/api-reference/v2/openapiV2.json)
- [openapiV1](https://developers.nlpearl.ai/api-reference/v1/openapiV1.json)
- [ApiNLPearl](https://developers.nlpearl.ai/api-reference/ApiNLPearl.json)