Postman Collection

OutCallerAI offers a dynamic, workspace-tailored Postman collection that you can download directly from the dashboard and import into your Postman client to test all public API endpoints within seconds.

What is included?

Our Postman collection contains pre-configured requests for every public CRM API capability:

1. Workspace Management: Retrieve current configuration settings.
2. Campaign Control: Create, update, list, and delete outbound dialing campaigns.
3. AI Agent Personas: Set up prompt scripts and agent personas.
4. Lead Lists: Import single or bulk leads into any active campaign.
5. Real-time Calls: Initiate outbound voice calls immediately from your agent personas.

Setup & Download

1. Navigate to Integrations: Go to the Integrations Page inside the OutCallerAI dashboard.
2. Download from the header: Click Download Postman Collection next to View API Keys.
3. Generate API Key & Download: If you don't have an active API key, the dashboard will automatically generate one before downloading.
4. Import into Postman:
   • Open your Postman App.
   • Click Import in the top left.
   • Drag and drop or select the downloaded .postman_collection.json file.

Authentication & Variables

The downloaded collection is self-contained. It uses collection-level Bearer Auth with your API key variable:

Authorization: Bearer {{outcaller_api_key}}

It is pre-configured with variables under the collection properties:

• base_url: Automatically set to your OutCallerAI instance URL (e.g. http://localhost:3000 or production URL).
• outcaller_api_key: Pre-populated with your workspace's API key.
• agent_id, campaign_id, lead_id, call_id: Blank IDs you can fill after creating or finding resources.

[!NOTE] If you regenerate your API key in the Workspace API Setup page, update the value of the outcaller_api_key collection variable to restore authorization for all requests.