GEgetpuppeteer
Voice

Create Phone Call

Find or create a thread for the given phone number and project, then initiate a phone call.

post/voice/phone-call

Request

  • Base URL
    https://api.puppeteerai.com
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

API key for your Puppeteer organization.

Request body

calleestring required

The phone number to call, in E.164 format (e.g., +12025550123).

project_idstring required

The UUID of the Puppeteer project.

timezonestring nullable

Timezone for the thread (e.g., "America/Chicago").

json_datastring nullable

JSON data as a string to be sent to the thread upon creation. This data will be processed by the thread's JSON input handler.

scheduled_forstring date-time nullable

ISO 8601 datetime to schedule the call for a future time. If omitted, the call starts immediately.

backgroundboolean

When true, the call is queued and the endpoint returns 202 immediately. When false (default), the call is initiated synchronously.

retell_account_idstring nullable

The UUID of the Retell account to use. Required when the project has multiple phone numbers.

Response

Successful Response

thread_idstring required

The unique identifier for the thread (new or existing).

Changes

No recorded changes to this operation across all 1 revision of this API.