GET STARTED / INTRODUCTION

Build on ZeroPipeline

ZeroPipeline is an AI-native pipeline platform built around four core primitives: agents, records, pipelines, and approvals. Together they give your team full programmable control over every step in your revenue workflow — from lead discovery to closed-won.

The REST API is designed to be predictable and resource-oriented. It uses standard HTTP verbs, returns JSON, and uses standard HTTP response codes. Authentication is handled with Bearer tokens.

GET STARTED / QUICKSTART

Get up in five minutes

Install the SDK and make your first API call.

# install via npm
npm install @zeropipeline/sdk

import { ZeroPipeline } from '@zeropipeline/sdk';

const client = new ZeroPipeline({
  apiKey: process.env.ZEROPIPELINE_API_KEY,
});

// fetch your pipeline
const pipeline = await client.pipelines.get('pipe_abc123');
console.log(pipeline.name); // "Q3 Enterprise"

GET STARTED / AUTHENTICATION

Authentication

All API requests must include your API key as a Bearer token in the Authorization header.

curl https://api.zeropipeline.io/v1/pipelines \
  -H "Authorization: Bearer $ZEROPIPELINE_API_KEY"

PRIMITIVES / AGENTS

Agents

Agents are autonomous workers that execute tasks inside your pipelines. Each agent has a role, memory context, and a set of tools it can invoke.

PRIMITIVES / RECORDS

Records

Records are typed entities — customers, deals, activities, and tasks. Every record has a stable ID, a set of typed fields, and an audit log.

{
  "id": "rec_8kx2mq",
  "type": "customer",
  "fields": {
    "name": "Acme Corp",
    "arr": 240000,
    "stage": "qualified"
  },
  "created_at": "2026-01-14T10:22:00Z"
}

PRIMITIVES / PIPELINES

Pipelines

Pipelines define the stages a deal moves through. Each stage can have entry conditions, automation triggers, and required approvals before advancement.

const pipeline = await client.pipelines.create({
  name: 'Enterprise ',
  stages: [
    { name: 'discovery', order: 1 },  
    { name: 'qualified', order: 2 },  
    { name: 'closed', order: 3 },
  ],
});

PRIMITIVES / APPROVALS

Approvals

Gate any pipeline transition behind a human approval. Approvals can require one or many approvers and support async Slack/email-based resolution.

curl -X POST https://api.zeropipeline.io/v1/approvals \
  -H "Authorization: Bearer $ZEROPIPELINE_API_KEY" \
  -d '{"deal_id":"deal_xyz","required_by":["user_abc"]}'

API / REST REFERENCE

REST reference

The full interactive API reference is available at pipeline.ainative.studio/api/v1/docs. It includes all endpoints, request/response schemas, and live examples you can run directly.

API / WEBHOOKS

Webhooks

Subscribe to real-time events from your pipeline. Webhooks are delivered via HTTP POST to your endpoint with a signed payload.

// verify the webhook signature
import { verifyWebhook } from '@zeropipeline/sdk/webhooks';

const event = verifyWebhook(req.body, req.headers['zp-signature']);
if (event.type === 'deal.stage_changed') {
  console.log(event.data.to_stage);
}

API / SDKS

SDKs

Official client libraries are available for TypeScript, Python, and Go. Community SDKs exist for Ruby, PHP, and Rust.

# TypeScript / Node.js
npm install @zeropipeline/sdk

# Python
pip install zeropipeline

# Go
go get github.com/zeropipeline/go-sdk