# Pingr AI

- [Quickstart](https://zeply.mintlify.app/quickstart.md): Get started with Pingr AI in under 5 minutes
- [Authentication](https://zeply.mintlify.app/authentication.md): How to authenticate your requests against the Pingr AI REST and Realtime APIs
- [Agent Overview](https://zeply.mintlify.app/agents/overview.md): Core concepts of Pingr AI voice agents, pipeline architectures, and execution flow
- [Creating an Agent](https://zeply.mintlify.app/agents/create.md): Step-by-step guide to provisioning new conversational agents
- [Outbound Calls](https://zeply.mintlify.app/telephony/outbound-calls.md): Triggering single and concurrent outbound calls to PSTN networks
- [Campaign Scheduling](https://zeply.mintlify.app/campaigns/scheduling.md): Orchestrate large-scale outbound calling and messaging campaigns
- [Webhooks](https://zeply.mintlify.app/webhooks/overview.md): Listen to real-time events for calls, recordings, and agent execution
- [Introduction](https://zeply.mintlify.app/introduction.md): Welcome to Pingr AI — Next-generation conversational voice agents and multi-channel automation engine
- [API Reference](https://zeply.mintlify.app/api-reference.md): Interactive endpoints, schemas, and specifications for the Pingr AI REST API
- [Introduction](https://zeply.mintlify.app/api-reference/introduction.md): Overview of the Pingr AI REST API architecture and developer platform
- [Authentication](https://zeply.mintlify.app/api-reference/authentication.md): Authenticate API requests using scoped secret Bearer tokens
- [Pagination](https://zeply.mintlify.app/api-reference/pagination.md): Navigate through large result sets using cursor-based pagination
- [Rate Limiting](https://zeply.mintlify.app/api-reference/rate-limiting.md): Understand rate limits, burst quotas, and headers across Pingr AI endpoints
- [Errors and Status Codes](https://zeply.mintlify.app/api-reference/errors.md): Comprehensive guide to Pingr AI HTTP status codes and error payloads
- [Limits & Quotas](https://zeply.mintlify.app/api-reference/limits.md): System limits, payload constraints, and concurrency quotas across Pingr AI
- [Agents Overview](https://zeply.mintlify.app/api-reference/agents/overview.md): Build, configure, and orchestrate real-time conversational Voice AI agents with Pingr AI
- [Get agent](https://zeply.mintlify.app/api-reference/agents/get-agent.md): Retrieve detailed Voice AI agent information, including configuration, status, and tasks.
- [Create agent](https://zeply.mintlify.app/api-reference/agents/create-agent.md): Provision a new conversational Voice AI prompt agent or rule-based static bot
- [List agents](https://zeply.mintlify.app/api-reference/agents/list-agents.md): Retrieve all Voice AI agents belonging to your organization
- [Update agent](https://zeply.mintlify.app/api-reference/agents/update-agent.md): Update complete configuration and behavioral parameters of an existing Voice AI agent
- [Delete agent](https://zeply.mintlify.app/api-reference/agents/delete-agent.md): Permanently remove an existing Voice AI agent
- [Campaigns Overview](https://zeply.mintlify.app/api-reference/campaigns/overview.md): Broadcast targeted WhatsApp messaging and voice campaigns with Pingr AI
- [Create campaign](https://zeply.mintlify.app/api-reference/campaigns/create-campaign.md): Create a new outbound WhatsApp broadcast campaign for immediate or scheduled dispatch
- [List campaigns](https://zeply.mintlify.app/api-reference/campaigns/list-campaigns.md): Retrieve a paginated list of campaigns for the organization with live broadcast metrics
- [Get campaign](https://zeply.mintlify.app/api-reference/campaigns/get-campaign.md): Retrieve complete campaign configuration, audience parameters, and live broadcast delivery telemetry
- [Pause campaign](https://zeply.mintlify.app/api-reference/campaigns/pause-campaign.md): Halt an active sending or scheduled campaign dispatch
- [Resume campaign](https://zeply.mintlify.app/api-reference/campaigns/resume-campaign.md): Resume delivery of a previously paused outbound WhatsApp campaign
- [Cancel campaign](https://zeply.mintlify.app/api-reference/campaigns/cancel-campaign.md): Permanently terminate an in-flight, paused, or scheduled outbound campaign
- [Delete campaign](https://zeply.mintlify.app/api-reference/campaigns/delete-campaign.md): Permanently delete an outbound campaign and purge associated broadcast records
- [Export campaign PDF](https://zeply.mintlify.app/api-reference/campaigns/export-pdf.md): Download an executive summary PDF performance report for a campaign
- [Contacts Overview](https://zeply.mintlify.app/api-reference/contacts/overview.md): Manage customer profiles, segmentation tags, custom metadata, and bulk ingestion in Pingr AI
- [Create contact](https://zeply.mintlify.app/api-reference/contacts/create-contact.md): Register a new contact in your organization's address book
- [List contacts](https://zeply.mintlify.app/api-reference/contacts/list-contacts.md): Retrieve all contacts associated with your organization
- [Update contact](https://zeply.mintlify.app/api-reference/contacts/update-contact.md): Modify an existing contact's details, tags, or custom metadata
- [Delete contact](https://zeply.mintlify.app/api-reference/contacts/delete-contact.md): Permanently delete a contact from your organization's address book
- [Bulk upload contacts](https://zeply.mintlify.app/api-reference/contacts/bulk-upload.md): Batch import contacts from CSV or Excel (.xlsx/.xls) spreadsheets with automatic deduplication
- [Templates Overview](https://zeply.mintlify.app/api-reference/templates/overview.md): Design, synchronize, and manage Meta-approved WhatsApp Business message templates in Pingr AI
- [Create template](https://zeply.mintlify.app/api-reference/templates/create-template.md): Register a new structured WhatsApp message template locally and submit it to Meta for approval
- [List templates](https://zeply.mintlify.app/api-reference/templates/list-templates.md): Retrieve a paginated list of WhatsApp message templates for your organization
- [Get template](https://zeply.mintlify.app/api-reference/templates/get-template.md): Retrieve comprehensive configuration, components, and approval status for a template
- [Delete template](https://zeply.mintlify.app/api-reference/templates/delete-template.md): Permanently delete a template locally and deregister it from Meta Graph API
- [Sync templates](https://zeply.mintlify.app/api-reference/templates/sync-templates.md): Synchronize approved message templates from your Meta WhatsApp Business Account to Pingr AI
- [Get template library](https://zeply.mintlify.app/api-reference/templates/get-library.md): Browse and filter Meta's global catalog of pre-approved WhatsApp message templates
- [Create from library](https://zeply.mintlify.app/api-reference/templates/create-from-library.md): Instantaneously provision a pre-approved template from Meta's library to your WhatsApp Business Account
- [Knowledge Base Overview](https://zeply.mintlify.app/api-reference/knowledge-base/overview.md): Upload, store, and ingest enterprise documents for real-time RAG context in Voice AI and messaging
- [Upload document](https://zeply.mintlify.app/api-reference/knowledge-base/upload-document.md): Upload a document to object storage and trigger automated vector chunking and indexing
- [List documents](https://zeply.mintlify.app/api-reference/knowledge-base/list-documents.md): Retrieve all knowledge documents indexed for your organization
- [Download document](https://zeply.mintlify.app/api-reference/knowledge-base/download-document.md): Download raw document file content from secure object storage
- [Delete document](https://zeply.mintlify.app/api-reference/knowledge-base/delete-document.md): Permanently delete a document from database metadata, object storage, and the vector index
- [Webhooks Overview](https://zeply.mintlify.app/api-reference/webhooks/overview.md): Subscribe to real-time event notifications for calls, conversations, AI executions, and campaigns
- [Create webhook](https://zeply.mintlify.app/api-reference/webhooks/create-webhook.md): Register a new external HTTPS webhook listener and generate a unique signing secret
- [List webhooks](https://zeply.mintlify.app/api-reference/webhooks/list-webhooks.md): Retrieve all registered webhook subscriptions for your organization
- [Get webhook](https://zeply.mintlify.app/api-reference/webhooks/get-webhook.md): Retrieve complete subscription details and signing secret for a webhook
- [Update webhook](https://zeply.mintlify.app/api-reference/webhooks/update-webhook.md): Modify webhook callback URL, subscribed events, or active status
- [Delete webhook](https://zeply.mintlify.app/api-reference/webhooks/delete-webhook.md): Permanently deregister a webhook subscription
- [Call Logs Overview](https://zeply.mintlify.app/api-reference/call-logs/overview.md): Inspect historical telephony and WhatsApp voice calls, transcripts, latency metrics, and audio recordings
- [List call logs](https://zeply.mintlify.app/api-reference/call-logs/list-call-logs.md): Retrieve a paginated list of call logs for your organization with optional search and filters
- [Get call log](https://zeply.mintlify.app/api-reference/call-logs/get-call-log.md): Retrieve comprehensive details, transcript, and qualitative summary for a specific call
- [Get call recording audio](https://zeply.mintlify.app/api-reference/call-logs/get-recording-audio.md): Stream or download recorded WhatsApp voice call audio directly via secure proxy
- [Quick Replies Overview](https://zeply.mintlify.app/api-reference/quick-replies/overview.md): Configure standardized message snippets and slash command shortcuts for agent chat acceleration
- [Create quick reply](https://zeply.mintlify.app/api-reference/quick-replies/create-quick-reply.md): Register a new canned message shortcut and template for your organization
- [List quick replies](https://zeply.mintlify.app/api-reference/quick-replies/list-quick-replies.md): Retrieve paginated quick reply snippets for the organization with automated Redis caching
- [Delete quick reply](https://zeply.mintlify.app/api-reference/quick-replies/delete-quick-reply.md): Permanently delete an existing quick reply snippet and evict cache entries
- [Inbox & Messaging Overview](https://zeply.mintlify.app/api-reference/inbox/overview.md): Manage omnichannel conversation tickets, two-way WhatsApp messaging, media attachments, and message reactions
- [Create ticket](https://zeply.mintlify.app/api-reference/inbox/create-ticket.md): Initialize a new inbox conversation ticket for a contact, or return an active open ticket
- [List tickets](https://zeply.mintlify.app/api-reference/inbox/list-tickets.md): Retrieve a paginated list of conversation tickets filtered by status or contact ID
- [Get ticket](https://zeply.mintlify.app/api-reference/inbox/get-ticket.md): Retrieve comprehensive details and contact profile for a specific inbox ticket
- [Update ticket status](https://zeply.mintlify.app/api-reference/inbox/update-ticket-status.md): Open or close an active conversation ticket in the organization's inbox
- [List messages](https://zeply.mintlify.app/api-reference/inbox/list-messages.md): Retrieve paginated messages across the organization or optionally filtered by ticket ID
- [Get ticket messages](https://zeply.mintlify.app/api-reference/inbox/get-inbox-messages.md): Retrieve chronological chat message history for a specific conversation ticket
- [Send message](https://zeply.mintlify.app/api-reference/inbox/send-message.md): Send an outbound WhatsApp text or rich media message inside a conversation ticket
- [Upload media](https://zeply.mintlify.app/api-reference/inbox/upload-media.md): Upload a multimedia attachment to temporary S3 storage prior to sending via WhatsApp
- [Get message media](https://zeply.mintlify.app/api-reference/inbox/get-message-media.md): Securely stream and download attached media files from S3/R2 storage
- [React to message](https://zeply.mintlify.app/api-reference/inbox/react-to-message.md): Send or remove an emoji reaction to a WhatsApp message in the conversation thread