Introduction - Peachdesk AI

Peachdesk ships official SDKs for Python and TypeScript that wrap the Peachdesk REST API and the workflow builder. Use them to create or edit agents, place outbound calls, and inspect runs from your own code.

Python — peachdesk-sdk on PyPI (coming soon)
TypeScript — @peachdesk/sdk on npm (coming soon)

Both packages are generated from the same backend OpenAPI spec, so the method surface is equivalent — only the naming convention differs (snake_case in Python, camelCase in TypeScript).

Install

pip install peachdesk-sdk

npm install @peachdesk/sdk

Authenticate

Generate an API key at /utils/developers (or http://localhost:3010/utils/developers for self-hosted). See API Keys for details. Both SDKs read the API key from the PEACHDESK_API_KEY environment variable by default, and the base URL from PEACHDESK_API_URL (defaults to http://localhost:8000). You can also pass them explicitly.

from peachdesk_sdk import PeachdeskClient

client = PeachdeskClient(
    base_url="https://api.peachdeskai.com",
    api_key="YOUR_API_KEY",
)

import { PeachdeskClient } from "@peachdesk/sdk";

const client = new PeachdeskClient({
    baseUrl: "https://api.peachdeskai.com",
    apiKey: "YOUR_API_KEY",
});

For self-hosted deployments, swap baseUrl for your backend URL (e.g. http://localhost:8000).

Quick tour

List the agents in your workspace:

workflows = client.list_workflows()
for wf in workflows:
    print(wf.id, wf.name)

const workflows = await client.listWorkflows();
for (const wf of workflows) {
    console.log(wf.id, wf.name);
}

Next steps

Build an agent — assemble nodes and edges, save as a draft
Place an outbound call — trigger a call from an agent to a phone number
MCP Server — let Claude and other coding agents drive the SDK for you