# Verbex Docs

## Docs

- [Agentic AI Prompt Guidelines](https://docs.verbex.ai/agents/agentic-prompt-guidelines.md): Learn how to write clear and effective instructions for your Agentic AI Agent's capabilities, tasks, and tools.
- [Guideline for Desigining the Agentic Workflow](https://docs.verbex.ai/agents/agentic-workflow-guideline.md): Learn how to design effective agentic workflows with step-by-step guidance for beginners. This guide helps you create automated processes that work intelligently to accomplish your goals.
- [Creating Agentic AI Agent](https://docs.verbex.ai/agents/create-agentic-agent.md)
- [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
- [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 AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/create-ai-agent.md): Create a new AI agent with the provided configuration.
- [Delete AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/delete-ai-agent.md): Delete an AI agent.
- [Get AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/get-ai-agent.md): Retrieve details of a specific AI agent.
- [List AI Agents](https://docs.verbex.ai/api-reference/ai-agents-v2/list-ai-agents.md): List AI agents with pagination.
- [Update AI Agent](https://docs.verbex.ai/api-reference/ai-agents-v2/update-ai-agent.md): Update an existing AI agent.
- [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
- [List API Keys](https://docs.verbex.ai/api-reference/api-keys/list-api-keys.md): List all API keys for the user
- [Revoke API Key](https://docs.verbex.ai/api-reference/api-keys/revoke-api-key.md): Revoke an API key
- [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.
- [Delete built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/delete-built-in-tool.md): Delete a built-in tool.
- [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.
- [List built-in tools](https://docs.verbex.ai/api-reference/built-in-tools/list-built-in-tools.md): List built-in tools with pagination.
- [Update built-in tool](https://docs.verbex.ai/api-reference/built-in-tools/update-built-in-tool.md): Update an existing built-in tool.
- [Download Call Recording](https://docs.verbex.ai/api-reference/call-recording/download-call-recording.md): Download the recording file for a specific call.
- [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.
- [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.
- [Create custom tool](https://docs.verbex.ai/api-reference/custom-tools/create-custom-tool.md): Create a new custom tool with the provided configuration.
- [Delete custom tool](https://docs.verbex.ai/api-reference/custom-tools/delete-custom-tool.md): Delete a custom tool.
- [Get custom tool](https://docs.verbex.ai/api-reference/custom-tools/get-custom-tool.md): Retrieve details of a specific custom tool.
- [List custom tools](https://docs.verbex.ai/api-reference/custom-tools/list-custom-tools.md): List custom tools with pagination.
- [Update custom tool](https://docs.verbex.ai/api-reference/custom-tools/update-custom-tool.md): Update an existing custom tool.
- [Getting an API Key](https://docs.verbex.ai/api-reference/introduction.md): How to get an API key for Verbex Platform
- [Add Files Document](https://docs.verbex.ai/api-reference/knowledge-bases-v2/add-files-document.md): Add a file document to the knowledge base by providing the file and document_type.
- [Add Website Document](https://docs.verbex.ai/api-reference/knowledge-bases-v2/add-website-document.md): Add a website document to the knowledge base by providing the base URL and selected sitemap URLs.
- [Check Document Processing Status](https://docs.verbex.ai/api-reference/knowledge-bases-v2/check-document-processing-status.md): Checks the processing status of a website document. This endpoint is useful for monitoring the progress of website crawling and vectorization.
- [Create Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases-v2/create-knowledge-base.md): Creates a new knowledge base for storing and managing documents. A knowledge base serves as a container  for related documents that can be used by AI agents for context and information retrieval. Each knowledge  base is isolated and can have its own set of documents, making it ideal for organizing d…
- [Delete Document](https://docs.verbex.ai/api-reference/knowledge-bases-v2/delete-document.md): Removes a specific document from the knowledge base. This operation deletes both the document's content and its associated vector embeddings from the system. The deletion is permanent and cannot be undone. The knowledge base itself remains intact, only the specified document is removed.
- [Delete Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases-v2/delete-knowledge-base.md): Permanently deletes a knowledge base and all its associated documents. This action cannot be undone, and all documents, embeddings, and metadata associated with the knowledge base will be removed from the system. Ensure you have backed up any important data before deletion.
- [Fetch Website Sitemap](https://docs.verbex.ai/api-reference/knowledge-bases-v2/fetch-website-sitemap.md): Retrieves the internal site map of a website. This endpoint is useful for discovering the structure of a website and its pages, which can be used to add the website to a knowledge base.
- [Get Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases-v2/get-knowledge-base.md): Retrieves detailed information about a specific knowledge base, including its metadata, configuration, and statistics. This endpoint is useful for checking the current state of a knowledge base, including the number of documents it contains and its last update timestamp.
- [List Documents](https://docs.verbex.ai/api-reference/knowledge-bases-v2/list-documents.md): Retrieves a paginated list of all documents within a specific knowledge base. Each document entry includes metadata such as the document type, processing status, creation timestamp, and other relevant information. This endpoint is useful for monitoring document status and managing the contents of a…
- [List Knowledge Bases](https://docs.verbex.ai/api-reference/knowledge-bases-v2/list-knowledge-bases.md): Retrieves a paginated list of all knowledge bases accessible to the authenticated user. The results can be paginated using the page_size and page_token parameters. This endpoint is useful for discovering and managing multiple knowledge bases, with each entry including basic metadata about the knowle…
- [Update Knowledge Base](https://docs.verbex.ai/api-reference/knowledge-bases-v2/update-knowledge-base.md): Updates the configuration and metadata of an existing knowledge base. This allows you to modify  properties such as the name, description, or any custom settings associated with the knowledge base while preserving its documents and relationships.
- [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:
- [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:
- [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…
- [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:
- [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:
- [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 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
- [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.
- [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
- [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.
- [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.
- [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.
- [Generating Batch Calls](https://docs.verbex.ai/batch_call.md)
- [Verbex Changelog](https://docs.verbex.ai/changelog/changelog.md): Verbex Changelog
- [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
- [RBAC Guideline](https://docs.verbex.ai/configure-rbac.md)
- [Configuring Advanced Settings](https://docs.verbex.ai/configure_adv.md)
- [Test Your Configured Assistant](https://docs.verbex.ai/configure_test.md)
- [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
- [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
- [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.
- [Prompting Guide -Simple Agent](https://docs.verbex.ai/documentation/resources/prompting-guide-simple-agent.md)
- [Dynamic Data Management](https://docs.verbex.ai/external_context/dynamic_data.md): Learn how to provide dynamic data to your AI agents.
- [Frequently Asked Questions](https://docs.verbex.ai/faq.md)
- [Getting Started](https://docs.verbex.ai/introduction.md): Learn how to build and manage intelligent AI Agents with Verbex Platform
- [KMS Encryption User Guide](https://docs.verbex.ai/kms-encryption-user-guide.md)
- [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
- [Accessing Call Logs](https://docs.verbex.ai/monitoring/access-call-logs.md): Learn how to access and review call logs in Verbex
- [Creating Your Own Verbex AI Agent](https://docs.verbex.ai/step-by-step-workflow.md)
- [Built-in Tools](https://docs.verbex.ai/tools/built-in-tools.md): Overview of pre-configured tools available in the Verbex platform
- [Calendar Integration](https://docs.verbex.ai/tools/built-in-tools-calendar.md): Connect your calendar with Verbex to manage appointments and check schedules
- [Call Transfer Tool](https://docs.verbex.ai/tools/built-in-tools-call-transfer.md): Enable seamless call transfers between AI assistants and human agents
- [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
- [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
- [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
- [Encryption Guideline](https://docs.verbex.ai/untitled-page.md)
- [RBAC User Guide](https://docs.verbex.ai/user-manual.md)
- [Verbex Videos - Introduction](https://docs.verbex.ai/video-tutorials/introduction.md): Verbex AI Video Tutorials
- [WAF User Guide](https://docs.verbex.ai/waf-user-manual.md)
- [Web Application Firewall Guideline](https://docs.verbex.ai/web-application-firewall-guideline.md)
- [Verbex Webhook Implementation Guide](https://docs.verbex.ai/webhook.md)
- [ Workspace](https://docs.verbex.ai/workspace.md)
- [Workspace Knowledge Base Management](https://docs.verbex.ai/workspace_kb_access.md)

## OpenAPI Specs

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