Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.planasonix.com/llms.txt

Use this file to discover all available pages before exploring further.

Templates capture a pipeline definition so teams can reuse patterns, onboard faster, and publish approved flows. Use the API to list templates, create them from existing pipelines, share with other workspaces or users, and collect ratings. 
Authorization: Bearer YOUR_API_KEY_HERE
If your workspace uses URL versioning, insert /v1 before /api in the path. See API reference.

​
List templates

GET https://api.planasonix.com/api/templates
Supports standard list query parameters where implemented (search, tags, visibility, sort). 
{
  "data": [
    {
      "id": "tmpl_01j9k5h6i7j8k9l0",
      "name": "CDC to warehouse — standard",
      "description": "Debezium-style capture with SCD2 landing in Snowflake",
      "visibility": "organization",
      "tags": ["cdc", "snowflake", "scd2"],
      "pipeline_id": "pl_01hqxyz",
      "version": 3,
      "rating_avg": 4.7,
      "rating_count": 18,
      "created_at": "2025-02-10T08:00:00Z",
      "updated_at": "2025-03-25T19:30:00Z",
      "created_by": "usr_01h8abc"
    }
  ],
  "meta": {
    "page": { "limit": 25, "cursor": null }
  }
}

​
Create template from pipeline

POST https://api.planasonix.com/api/templates
Content-Type: application/json
FieldTypeDescription
pipeline_idstringSource pipeline to snapshot
namestringTemplate title
descriptionstringOptional markdown-friendly summary
visibilitystringTypical values: private, organization, public
tagsstring[]Optional labels for discovery
{
  "pipeline_id": "pl_01hqxyz",
  "name": "Daily sales rollup",
  "description": "Extracts from Postgres, dimensions in dbt-style transforms, load to BigQuery",
  "visibility": "organization",
  "tags": ["sales", "postgres", "bigquery"]
}

{
  "data": {
    "id": "tmpl_01j9k6m7n8o9p0q1",
    "name": "Daily sales rollup",
    "pipeline_id": "pl_01hqxyz",
    "version": 1,
    "created_at": "2025-03-27T11:12:00Z"
  }
}

​
Get template

GET https://api.planasonix.com/api/templates/{id}
Returns template metadata and the serialized pipeline graph (nodes, edges, parameters) your key is allowed to read. 
{
  "data": {
    "id": "tmpl_01j9k5h6i7j8k9l0",
    "name": "CDC to warehouse — standard",
    "description": "Debezium-style capture with SCD2 landing in Snowflake",
    "visibility": "organization",
    "tags": ["cdc", "snowflake", "scd2"],
    "version": 3,
    "definition": {
      "nodes": [
        {
          "id": "n_source",
          "type": "postgres_cdc",
          "config": { "slot_name": "planasonix_sales" }
        },
        {
          "id": "n_transform",
          "type": "sql",
          "config": { "query": "SELECT * FROM cdc.sales WHERE op != 'd'" }
        }
      ],
      "edges": [{ "from": "n_source", "to": "n_transform" }]
    },
    "created_at": "2025-02-10T08:00:00Z",
    "updated_at": "2025-03-25T19:30:00Z"
  }
}

​
Update template

PUT https://api.planasonix.com/api/templates/{id}
Content-Type: application/json

{
  "name": "CDC to warehouse — standard (v4)",
  "description": "Adds dead-letter handling for poison messages",
  "tags": ["cdc", "snowflake", "scd2", "dlq"]
}

​
Delete template

DELETE https://api.planasonix.com/api/templates/{id}

{
  "data": {
    "id": "tmpl_01j9k5h6i7j8k9l0",
    "deleted": true
  }
}

​
Share template

POST https://api.planasonix.com/api/templates/{id}/share
Content-Type: application/json

{
  "share_with": "workspace",
  "workspace_ids": ["ws_01demo", "ws_01partner"],
  "permission": "use",
  "message": "Approved for partner analytics onboarding"
}

{
  "data": {
    "template_id": "tmpl_01j9k5h6i7j8k9l0",
    "shares": [
      {
        "workspace_id": "ws_01demo",
        "permission": "use",
        "shared_at": "2025-03-27T12:00:00Z"
      }
    ]
  }
}

​
Rate a template

POST https://api.planasonix.com/api/templates/{id}/rate
Content-Type: application/json

{
  "score": 5,
  "comment": "Saved us two weeks wiring CDC correctly."
}

{
  "data": {
    "template_id": "tmpl_01j9k5h6i7j8k9l0",
    "your_score": 5,
    "rating_avg": 4.8,
    "rating_count": 19
  }
}

Templates (guides)

Using templates in the UI.

API reference

Base URL and response envelopes.