AI Product Ops Toolkit

API docs

Use API v2 to run generation, batch jobs, vaults, and outbound automation.

API v2 is the developer surface for Advisory accounts. It supports vault-aware generation, durable batch jobs, webhook subscriptions, Zapier polling, and Make-compatible entry points.

What API v2 includes

- API v2 supports `vaultId`, `customPromptId`, `stream`, and channel-ready export formats.
- Batch jobs can be created programmatically and can post completion payloads to a callback URL.
- Signed outbound webhooks fire for generation completion, batch completion, and approved outputs.
- Zapier and Make now have dedicated integration entry points.
- API keys can be limited by scope, workflow module allowlist, and per-key burst caps.

Open API Settings Download OpenAPI JSON

Available endpoints

/api/v2/modules

List supported workflow modules, inputs, and output schemas.

/api/v2/generate

Run a single workflow generation with optional vault context and custom prompt variants.

/api/v2/batch

Queue a durable batch run and optionally post completion results to a callback URL.

/api/v2/vault

Create or list context vaults over API-key auth.

/api/v2/webhooks

/api/v2/zapier/trigger/generation-complete

Polling-friendly trigger surface for Zapier.

/api/v2/make

Make-compatible entry point for generate and batch operations.

Single generation example

curl -X POST "https://aiproductops.net/api/v2/generate" \
  -H "Authorization: Bearer aipot_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "moduleSlug": "weekly-status-pack",
    "exportFormat": "slack",
    "vaultId": "your-vault-id",
    "userInputs": {
      "project_updates": "Checkout hardening shipped, release sign-off is pending support review, and the QA defect count is down 42% week over week."
    }
  }'

Batch example

curl -X POST "https://aiproductops.net/api/v2/batch" \
  -H "Authorization: Bearer aipot_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "exportFormat": "markdown",
    "callbackUrl": "https://example.com/webhooks/pm-ops-batch",
    "items": [
      {
        "moduleSlug": "weekly-status-pack",
        "title": "Payments squad",
        "inputs": {
          "project_updates": "Sprint closeout complete, launch blockers narrowed to analytics and support enablement."
        }
      }
    ]
  }'

Authentication

- Use `Authorization: Bearer <api-key>` or `X-Api-Key`.
- Public API access is reserved for Advisory.
- API v2 supports streaming SSE when `stream: true` is sent to `/api/v2/generate`.
- Create one key per system and grant only the scopes that automation actually needs.
- Optional workflow allowlists can limit a key to specific toolkit modules such as `weekly-status-pack`.
- Each key has its own burst cap so exposed automations can be throttled without affecting other systems.

Webhook payload

{
  "id": "generation.complete:saved-output-id",
  "type": "generation.complete",
  "occurredAt": "2026-04-08T16:45:00.000Z",
  "data": {
    "moduleSlug": "weekly-status-pack",
    "savedOutputId": "saved-output-id",
    "generationId": "generation-id",
    "text": "*Executive Summary*\n...",
    "canonicalText": "## Executive Summary\n..."
  }
}

Webhook delivery

- Signed endpoints receive `X-PM-Ops-Signature: sha256=<hex>`.
- Failed deliveries are retried with 5s, 30s, and 120s backoff.
- Delivery attempts are visible from API settings inside the app.

What API v2 includes

- API v2 supports `vaultId`, `customPromptId`, `stream`, and channel-ready export formats.

- Batch jobs can be created programmatically and can post completion payloads to a callback URL.

- Signed outbound webhooks fire for generation completion, batch completion, and approved outputs.

- Zapier and Make now have dedicated integration entry points.

- API keys can be limited by scope, workflow module allowlist, and per-key burst caps.

Available endpoints

/api/v2/modules

List supported workflow modules, inputs, and output schemas.

/api/v2/generate

Run a single workflow generation with optional vault context and custom prompt variants.

/api/v2/batch

Queue a durable batch run and optionally post completion results to a callback URL.

/api/v2/vault

Create or list context vaults over API-key auth.

/api/v2/webhooks

/api/v2/zapier/trigger/generation-complete

Polling-friendly trigger surface for Zapier.

/api/v2/make

Make-compatible entry point for generate and batch operations.

curl -X POST "https://aiproductops.net/api/v2/generate" \ -H "Authorization: Bearer aipot_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "moduleSlug": "weekly-status-pack", "exportFormat": "slack", "vaultId": "your-vault-id", "userInputs": { "project_updates": "Checkout hardening shipped, release sign-off is pending support review, and the QA defect count is down 42% week over week." } }'

curl -X POST "https://aiproductops.net/api/v2/batch" \ -H "Authorization: Bearer aipot_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "exportFormat": "markdown", "callbackUrl": "https://example.com/webhooks/pm-ops-batch", "items": [ { "moduleSlug": "weekly-status-pack", "title": "Payments squad", "inputs": { "project_updates": "Sprint closeout complete, launch blockers narrowed to analytics and support enablement." } } ] }'

Authentication

- Use `Authorization: Bearer <api-key>` or `X-Api-Key`.

- Public API access is reserved for Advisory.

- API v2 supports streaming SSE when `stream: true` is sent to `/api/v2/generate`.

- Create one key per system and grant only the scopes that automation actually needs.

- Optional workflow allowlists can limit a key to specific toolkit modules such as `weekly-status-pack`.

- Each key has its own burst cap so exposed automations can be throttled without affecting other systems.

{ "id": "generation.complete:saved-output-id", "type": "generation.complete", "occurredAt": "2026-04-08T16:45:00.000Z", "data": { "moduleSlug": "weekly-status-pack", "savedOutputId": "saved-output-id", "generationId": "generation-id", "text": "*Executive Summary*\n...", "canonicalText": "## Executive Summary\n..." } }