Get Started
Introduction
Base URL, authentication, and how the API reference is organized.
Related In Learn
Quick Start
A quick-start guide to understanding Pickaxe and building your first AI agent.
Pickaxe exposes a versioned HTTP API for deployments, workspace resources, and runtime-facing integrations.
Base URL
https://api.pickaxe.co/v1
Authentication
- Use
Authorization: Bearer YOUR_API_TOKENfor workspace-scoped endpoints. - Use the deployment API key as the bearer token for deployment completions.
- Most requests also send
Content-Type: application/json.
How This Reference Is Organized
Workspace APIcovers authenticated workspace context.Completions APIcovers deployment inference requests.CLI & Coding Agentscovers agent-driven workflows through the Pickaxe CLI.Webhookscovers outbound event notifications you can send to Zapier, Make, and other automation endpoints.- The remaining pages cover resource-specific CRUD and listing endpoints.
Notes
- Request and response examples below are copied from the product documentation in
v2-user. - Paths in this section are versioned under
/v1.
