Introduction

Connect your backend to Pineyard: manage agents, run calling campaigns, send WhatsApp messages and read call results over HTTPS.

The Pineyard API lets your own backend do what your team does in the Pineyard dashboard: set up AI calling agents, run campaigns against your contact lists, send WhatsApp messages, and read back call outcomes, transcripts, recordings and extracted lead data.

Quickstart

List agents, create a campaign, add contacts, start it and read the results.

Authentication

How API keys work and how to get one.

Run a campaign end to end

The full flow, including phone numbers, scheduling and retries.

Receive results

Get a signed webhook when each lead’s result is ready.

Base URL

All requests go to:

https://api.pineyard.ai

Requests and responses are JSON (Content-Type: application/json) unless an endpoint says otherwise (file uploads use multipart/form-data; exports return CSV).

Two API surfaces

Surface	Paths	What it is for
Public API	/v1/*	A small, stable surface for the most common integration: push leads into a running campaign and collect one final result per lead. Also manages campaigns, lists agents and phone numbers.
Workspace API	everything else (/agents, /campaigns, /calls, /whatsapp, …)	The same endpoints the Pineyard dashboard uses. Gives a scoped API key access to everything its scopes allow.

Both accept the same API key. What a key may do is controlled by its scopes.

The Workspace API is available to scoped API keys. Keys issued before scopes existed can call /v1 endpoints only.

Conventions

• Durations are in milliseconds. See Timestamps & durations.
• Errors are JSON objects with a machine-readable error code. See Errors.
• Retries are safe on billed endpoints when you send an Idempotency-Key. See Idempotency.
• Agent prompts are not returned. In agent responses prompt is an empty string and studioConfig is null. See Agents for the one exception.