Tinybird · Schema

Tinybird Pipe

Schema for a Tinybird Pipe resource representing a data transformation pipeline

AnalyticsDataReal-TimeSQLStreaming

Properties

Name	Type	Description
id	string	Unique identifier for the pipe
name	string	Name of the pipe
description	string	Human-readable description of the pipe's purpose
type	string	Pipe type determining its behavior
nodes	array	SQL transformation nodes in the pipe
created_at	string
updated_at	string
endpoint	string	Public API endpoint URL if the pipe is published as an endpoint

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tinybird/main/json-schema/tinybird-pipe-schema.json",
  "title": "Tinybird Pipe",
  "description": "Schema for a Tinybird Pipe resource representing a data transformation pipeline",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the pipe"
    },
    "name": {
      "type": "string",
      "description": "Name of the pipe"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the pipe's purpose"
    },
    "type": {
      "type": "string",
      "enum": ["standard", "materialized", "sink", "copy"],
      "description": "Pipe type determining its behavior"
    },
    "nodes": {
      "type": "array",
      "description": "SQL transformation nodes in the pipe",
      "items": {
        "$ref": "#/definitions/PipeNode"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "endpoint": {
      "type": "string",
      "description": "Public API endpoint URL if the pipe is published as an endpoint"
    }
  },
  "required": ["id", "name"],
  "definitions": {
    "PipeNode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "sql": {
          "type": "string",
          "description": "SQL transformation query for this node"
        },
        "description": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": ["id", "sql"]
    }
  }
}