# Verbex Docs

## Docs

- [Getting Started](https://docs.verbex.ai/introduction.md): Learn how to build and manage intelligent AI Agents with Verbex Platform
- [Creating Your Own Verbex AI Agent](https://docs.verbex.ai/step-by-step-workflow.md)
- [Creating Simple AI Agent](https://docs.verbex.ai/agents/create-simple-agent.md)
- [Writing Effective Prompts](https://docs.verbex.ai/agents/creating-effective-prompts-guide.md): Learn how to write clear instructions for your AI Agent's behavior and interactions
- [Automatic Prompt Generation for Simple Agent](https://docs.verbex.ai/agents/prompt-generation-simple-agent.md): Learn how to automatically generate prompts for simple agents to streamline your workflow and improve agent performance
- [Create an AI Agent Using a Template](https://docs.verbex.ai/agents/create-ai-agent-from-template.md): Discover how to effortlessly create an AI agent with a pre-defined template in Verbex
- [Flow Builder — Internal Reference Guide](https://docs.verbex.ai/agents/conversation-flow-builder.md): Internal QA and Product reference for the visual Flow Builder — every node type, edge rule, operator, variable behavior, model option, and validation limit, with QA test checklists.
- [Configure Your AI Agent](https://docs.verbex.ai/configure-ai-agent.md): Learn how to set up language, model, voice, and other key settings for your AI Agent
- [Post Call Analysis](https://docs.verbex.ai/configure-post-call-analysis.md): Learn how to analyze conversations between AI assistants and users after they happen
- [Configuring Advanced Settings](https://docs.verbex.ai/configure_adv.md)
- [Test Your Configured Assistant](https://docs.verbex.ai/configure_test.md)
- [Dynamic Data Management](https://docs.verbex.ai/external_context/dynamic_data.md): Learn how to provide dynamic data to your AI agents.
- [Using Tools](https://docs.verbex.ai/tools/connect-tools.md): Learn how to enhance your AI assistant by connecting it with external tools and APIs
- [Built-in Tools](https://docs.verbex.ai/tools/built-in-tools.md): Overview of pre-configured tools available in the Verbex platform
- [Send Email Tool](https://docs.verbex.ai/tools/built-in-tools-send-email.md): Configure Gmail integration to send automated emails through your AI assistant
- [Call Transfer Tool](https://docs.verbex.ai/tools/built-in-tools-call-transfer.md): Enable seamless call transfers between AI assistants and human agents
- [Calendar Integration](https://docs.verbex.ai/tools/built-in-tools-calendar.md): Connect your calendar with Verbex to manage appointments and check schedules
- [Custom Tools Integration](https://docs.verbex.ai/tools/custom-tools.md): Connect your AI assistant with external business systems using custom tools
- [Make.com Webhook Integration](https://docs.verbex.ai/tools/custom-tools-make-dot-com.md): Connect your Verbex AI Assistant with Make.com as a custom tool
- [Zapier Webhook Integration](https://docs.verbex.ai/tools/custom-tools-zapier.md): Connect your Verbex AI Assistant with Zapier Zap as a custom tool
- [Adding knowledge to your AI Agent](https://docs.verbex.ai/knowledge-base/add-knowledge-base.md): Learn how to set up and manage Knowledge Bases in Verbex Platform
- [Adding Documents to Knowledge Base](https://docs.verbex.ai/knowledge-base/adding-documents-to-knowledge-base.md): Learn how to add and manage documents in your Verbex Knowledge Base
- [Knowledge-Base Best Practices](https://docs.verbex.ai/knowledge-base/kb-best-practice.md): Guidelines for preparing the knowledge-base for best performance
- [Connect Twilio Phone Numbers to Verbex](https://docs.verbex.ai/deploy/connect-twilio-phone-numbers.md): Learn how to connect Twilio phone numbers to Verbex using Elastic SIP Trunking for making and receiving calls
- [Connecting Bangladesh Phone Numbers](https://docs.verbex.ai/deploy/connect-bangladesh-phone-numbers.md): Learn how to connect and manage Bangladesh phone numbers in Verbex
- [Making Outbound Phone Calls with Verbex](https://docs.verbex.ai/deploy/make-outbound-calls.md): Learn how to make outbound phone calls using the Verbex Platform.
- [ Workspace](https://docs.verbex.ai/workspace.md)
- [Workspace Knowledge Base Management](https://docs.verbex.ai/workspace_kb_access.md)
- [Generating Batch Calls](https://docs.verbex.ai/batch_call.md)
- [Accessing Call Logs](https://docs.verbex.ai/monitoring/access-call-logs.md): Learn how to access and review call logs in Verbex
- [Verbex Webhook Implementation Guide](https://docs.verbex.ai/webhook.md)
- [Webhook Subscription API](https://docs.verbex.ai/webhook-subscription-api.md)
- [Prompting Guide -Simple Agent](https://docs.verbex.ai/documentation/resources/prompting-guide-simple-agent.md)
- [Frequently Asked Questions](https://docs.verbex.ai/faq.md)
- [RBAC Guideline](https://docs.verbex.ai/configure-rbac.md)
- [RBAC User Guide](https://docs.verbex.ai/user-manual.md)
- [Web Application Firewall Guideline](https://docs.verbex.ai/web-application-firewall-guideline.md)
- [WAF User Guide](https://docs.verbex.ai/waf-user-manual.md)
- [KMS Encryption User Guide](https://docs.verbex.ai/kms-encryption-user-guide.md)
- [Getting an API Key](https://docs.verbex.ai/api-reference/introduction.md): How to get an API key for Verbex Platform
- [List AI Agents](https://docs.verbex.ai/api-reference/ai-agents-v2/list-ai-agents.md): List AI agents with pagination.
- [Create AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/create-ai-agent.md): Create a new AI agent with the provided configuration.
- [Get AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/get-ai-agent.md): Retrieve details of a specific AI agent.
- [Update AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/update-ai-agent.md): Update an existing AI agent.
- [Delete AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/delete-ai-agent.md): Delete an AI agent.
- [List built-in tools](https://docs.verbex.ai/api-reference/built-in-tools/list-built-in-tools.md): List built-in tools with pagination.
- [Create built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/create-built-in-tool.md): Create a new built-in tool with the provided configuration.
- [Get built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/get-built-in-tool.md): Retrieve details of a specific built-in tool.
- [Update built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/update-built-in-tool.md): Update an existing built-in tool.
- [Delete built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/delete-built-in-tool.md): Delete a built-in tool.
- [List custom tools](https://docs.verbex.ai/api-reference/custom-tools/list-custom-tools.md): List custom tools with pagination.
- [Create custom tool](https://docs.verbex.ai/api-reference/custom-tools/create-custom-tool.md): Create a new custom tool with the provided configuration.
- [Get custom tool](https://docs.verbex.ai/api-reference/custom-tools/get-custom-tool.md): Retrieve details of a specific custom tool.
- [Update custom tool](https://docs.verbex.ai/api-reference/custom-tools/update-custom-tool.md): Update an existing custom tool.
- [Delete custom tool](https://docs.verbex.ai/api-reference/custom-tools/delete-custom-tool.md): Delete a custom tool.
- [Create Web Call](https://docs.verbex.ai/api-reference/calls/create-web-call.md): Create a new web-based call session with an AI agent.
- [Create Web Call (Public Shared)](https://docs.verbex.ai/api-reference/calls/create-web-call-public-shared.md): Create a web call session using a public shared link.
- [Dial Outbound Phone Call](https://docs.verbex.ai/api-reference/calls/dial-outbound-phone-call.md): Initiate an outbound phone call from an AI agent to a specified phone number.
- [Get Call](https://docs.verbex.ai/api-reference/calls/get-call.md): Retrieve detailed information about a specific call by its ID.
- [List Calls](https://docs.verbex.ai/api-reference/calls/list-calls.md): Retrieve a paginated list of calls with optional filtering and sorting.
- [Get Signed URL for Call Recording](https://docs.verbex.ai/api-reference/call-recording/get-signed-url-for-call-recording.md): Get a pre-signed URL to access the recording of a specific call.
- [Download Call Recording](https://docs.verbex.ai/api-reference/call-recording/download-call-recording.md): Download the recording file for a specific call.
- [Get post-call analysis configuration for an agent](https://docs.verbex.ai/api-reference/post-call-analysis/get-post-call-analysis-configuration-for-an-agent.md): Get post-call analysis configuration for an agent
- [Update an existing post-call analysis configuration](https://docs.verbex.ai/api-reference/post-call-analysis/update-an-existing-post-call-analysis-configuration.md): Update an existing post-call analysis configuration
- [Create a new post-call analysis configuration](https://docs.verbex.ai/api-reference/post-call-analysis/create-a-new-post-call-analysis-configuration.md): Create a new post-call analysis configuration
- [Delete an existing post-call analysis configuration](https://docs.verbex.ai/api-reference/post-call-analysis/delete-an-existing-post-call-analysis-configuration.md): Delete the existing post-call analysis configuration for a specific AI agent.
- [Get Post Call Analysis Results](https://docs.verbex.ai/api-reference/post-call-analysis/get-post-call-analysis-results.md): Retrieve detailed post-call analysis results for a specific call.
- [Retrieve a paginated list of all phone numbers configured in your PIA Platform account](https://docs.verbex.ai/api-reference/phone-numbers/retrieve-a-paginated-list-of-all-phone-numbers-configured-in-your-pia-platform-account.md): Retrieve a paginated list of all phone numbers configured in your PIA Platform account. The list includes all phone number types (Import Phone Numbers and PIA-managed) and their current configurations. Use the page_size and page_token parameters to navigate through the list for accounts with many ph…
- [Create a new phone number](https://docs.verbex.ai/api-reference/phone-numbers/create-a-new-phone-number.md): Create and configure a new phone number in the PIA Platform. This endpoint supports two phone number types:
- [Retrieve detailed information about a specific phone number configuration](https://docs.verbex.ai/api-reference/phone-numbers/retrieve-detailed-information-about-a-specific-phone-number-configuration.md): Retrieve detailed information about a specific phone number configuration. The response includes:
- [Remove a phone number configuration from the PIA Platform](https://docs.verbex.ai/api-reference/phone-numbers/remove-a-phone-number-configuration-from-the-pia-platform.md): Remove a phone number configuration from the PIA Platform. This action:
- [Update the configuration of an existing phone number](https://docs.verbex.ai/api-reference/phone-numbers/update-the-configuration-of-an-existing-phone-number.md): Update the configuration of an existing phone number. This endpoint allows you to:
- [List Knowledge Bases](https://docs.verbex.ai/api-reference/knowledge-bases/list-knowledge-bases.md): Lists the knowledge bases your token can reach.
- [Create Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases/create-knowledge-base.md): Creates a knowledge base: a container for documents that AI agents search for context.
- [Get Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases/get-knowledge-base.md): Retrieves one knowledge base, including its chunking configuration, embedding model, and document count.
- [Delete Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases/delete-knowledge-base.md): Permanently deletes a knowledge base along with its documents and vectors. There is no undo.
- [Update Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases/update-knowledge-base.md): Updates a knowledge base. Every field is optional; omitting a field leaves it unchanged.
- [Upload a File](https://docs.verbex.ai/api-reference/knowledge-bases/upload-a-file.md): Uploads a file for asynchronous ingestion. Supported extensions: .pdf, .docx, .txt, .md, .xlsx, .xls.
- [Discover a Website's URLs](https://docs.verbex.ai/api-reference/knowledge-bases/discover-a-websites-urls.md): Discovers the URLs published by a website, so you can choose which to crawl.
- [Crawl Web Pages](https://docs.verbex.ai/api-reference/knowledge-bases/crawl-web-pages.md): Crawls the given pages for asynchronous ingestion.
- [List Documents](https://docs.verbex.ai/api-reference/knowledge-bases/list-documents.md): Lists the documents in a knowledge base.
- [Get Document Status](https://docs.verbex.ai/api-reference/knowledge-bases/get-document-status.md): Reports where a submitted document is in the ingestion pipeline.
- [Inspect Indexed Chunks](https://docs.verbex.ai/api-reference/knowledge-bases/inspect-indexed-chunks.md): Returns the chunks actually indexed for a document.
- [Delete a Document](https://docs.verbex.ai/api-reference/knowledge-bases/delete-a-document.md): Removes a document and its vectors from the knowledge base. The knowledge base itself is untouched.
- [Semantic Search](https://docs.verbex.ai/api-reference/knowledge-bases/semantic-search.md): Searches a knowledge base and returns ranked chunks.
- [Generate Prompt](https://docs.verbex.ai/api-reference/prompt-generation/generate-prompt.md): Generate a prompt based on the provided instruction and context.
- [Create Share](https://docs.verbex.ai/api-reference/public-sharing/create-share.md): Enables you to make an AI agent available to the users who has access to a shared key.
- [Get Share](https://docs.verbex.ai/api-reference/public-sharing/get-share.md): Retrieves the shared key and configuration that enables an AI agent to be available to users.
- [Delete Share](https://docs.verbex.ai/api-reference/public-sharing/delete-share.md): Removes the shared key and configuration that enables an AI agent to be available to users. The AI agent will no longer be accessible using the shared key.
- [Create a subscription](https://docs.verbex.ai/api-reference/webhook-subscriptions/create-a-subscription.md): Registers a new webhook subscription so Verbex delivers selected event notifications to your endpoint as HTTP POST requests. Optionally scope it to specific agents or workspaces, filter the `events` it receives, and enable HMAC-signed delivery. Returns the created subscription - including a one-time…
- [Get a subscription](https://docs.verbex.ai/api-reference/webhook-subscriptions/get-a-subscription.md): Retrieves a single subscription by its ID. Read endpoints never return the signing `secret` - use `signing_enabled` to tell whether signing is on.
- [Update a subscription](https://docs.verbex.ai/api-reference/webhook-subscriptions/update-a-subscription.md): Replaces the full configuration of an existing subscription (full-replacement `PUT` semantics - send every field you want to keep, or it may be cleared/reset). The required `enable_signed_webhooks` also drives the signing lifecycle. Returns the updated subscription - including a new one-time signing…
- [Delete a subscription](https://docs.verbex.ai/api-reference/webhook-subscriptions/delete-a-subscription.md): Permanently deletes a subscription; Verbex stops delivering its events. This cannot be undone - to temporarily stop deliveries instead, set `active: false` via Update.
- [Rotate the signing secret](https://docs.verbex.ai/api-reference/webhook-subscriptions/rotate-the-signing-secret.md): Generates a new signing `secret` for a subscription while keeping the previous secret valid for a 72-hour grace window, so in-flight receivers don't break. During that window Verbex signs each delivery with both secrets (two `v1=` values in `X-Webhook-Signature`). The new `secret` is returned once i…
- [List subscriptions](https://docs.verbex.ai/api-reference/webhook-subscriptions/list-subscriptions.md): Lists the subscriptions in your organization (cursor-paginated). Note the plural `subscriptions` path - distinct from the singular get-by-id. `secret` is never included.
- [List API Keys](https://docs.verbex.ai/api-reference/api-keys/list-api-keys.md): List all API keys for the user
- [Create API Key](https://docs.verbex.ai/api-reference/api-keys/create-api-key.md): Create a new API key
- [Get API Key](https://docs.verbex.ai/api-reference/api-keys/get-api-key.md): Get API key details
- [Revoke API Key](https://docs.verbex.ai/api-reference/api-keys/revoke-api-key.md): Revoke an API key
- [Verbex Videos - Introduction](https://docs.verbex.ai/video-tutorials/introduction.md): Verbex AI Video Tutorials
- [Verbex Changelog](https://docs.verbex.ai/changelog/changelog.md): Verbex Changelog

## OpenAPI Specs

- [openapi](https://docs.verbex.ai/api-reference/openapi.json)