Templates

Authorization: Bearer YOUR_API_KEY_HERE

GET https://api.planasonix.com/api/templates

{
  "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 }
  }
}

POST https://api.planasonix.com/api/templates
Content-Type: application/json

{
  "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 https://api.planasonix.com/api/templates/{id}

{
  "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"
  }
}

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 https://api.planasonix.com/api/templates/{id}

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

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"
      }
    ]
  }
}

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
  }
}