Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Apply table blueprint

POST /api/v1/tables/blueprints/apply

Apply a validated blueprint to the campaign table for a stored brief. Use external_agent when Codex, Claude Code, or another coding agent will produce and persist typed outputs without Pipeline-hosted inference.

Parameters

workspaceId

string

Optional with API key auth, inferred from the key.

briefIdrequired

string

No description.

blueprintrequired

object

No description.

executionModerequired

string

Use external_agent for Codex, Claude Code, and CLI subscription inference. Hosted BYOK execution must be selected explicitly with pipeline_hosted.

pipeline_hosted | external_agent

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/tables/blueprints/apply" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"briefId":"00000000-0000-4000-8000-000000000000","blueprint":{"name":"example","blocks":[{"id":"example","type":"company_snapshot"}]},"executionMode":"pipeline_hosted"}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "tableId": {
      "type": "string"
    },
    "created": {
      "type": "boolean"
    },
    "updated": {
      "type": "boolean"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "tableId",
    "created",
    "updated",
    "warnings"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.