Tinybird

opencollection: 1.0.0
info:
  name: Tinybird API
  version: v0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Data Sources
    type: folder
  items:
  - info:
      name: List Data Sources
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/datasources/
      params:
      - name: attrs
        value: ''
        type: query
        description: Comma-separated list of attributes to include in response
    docs: List all accessible data sources in the workspace.
  - info:
      name: Create Data Source
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/datasources/
      params:
      - name: mode
        value: ''
        type: query
        description: Operation mode - create, append, or replace
      - name: name
        value: ''
        type: query
        description: Name of the data source
      - name: format
        value: ''
        type: query
        description: Format of the data being ingested
      body:
        type: multipart-form
        data: []
    docs: Create, append, or replace a data source. The mode is determined by the mode parameter.
  - info:
      name: Get Data Source
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/datasources/:name
      params:
      - name: name
        value: ''
        type: path
        description: Name of the data source
    docs: Retrieve information and statistics for a specific data source.
  - info:
      name: Update Data Source
      type: http
    http:
      method: PUT
      url: https://api.tinybird.co/v0/datasources/:name
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update data source attributes like name or connector configuration.
  - info:
      name: Delete Data Source
      type: http
    http:
      method: DELETE
      url: https://api.tinybird.co/v0/datasources/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Drop an entire data source and all its data.
  - info:
      name: Alter Data Source
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/datasources/:name/alter
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Modify data source schema, description, or TTL settings.
  - info:
      name: Truncate Data Source
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/datasources/:name/truncate
      params:
      - name: name
        value: ''
        type: path
    docs: Remove all data from a data source while keeping the schema.
  - info:
      name: Delete Data Source Rows
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/datasources/:name/delete
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Delete rows matching specific SQL conditions from a data source.
- info:
    name: Events
    type: folder
  items:
  - info:
      name: Ingest Events
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/events
      params:
      - name: name
        value: ''
        type: query
        description: Name of the target data source
      - name: wait
        value: ''
        type: query
        description: Wait for the ingestion to complete before returning
      body:
        type: json
        data: '{}'
    docs: Ingest NDJSON events with a simple HTTP POST request to a data source.
- info:
    name: Pipes
    type: folder
  items:
  - info:
      name: List Pipes
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/pipes/
    docs: List all pipes in the workspace.
  - info:
      name: Create Pipe
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/pipes/
      body:
        type: json
        data: '{}'
    docs: Create a new pipe with SQL transformation nodes.
  - info:
      name: Get Pipe
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/pipes/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Retrieve details about a specific pipe.
  - info:
      name: Update Pipe
      type: http
    http:
      method: PUT
      url: https://api.tinybird.co/v0/pipes/:name
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update pipe attributes.
  - info:
      name: Delete Pipe
      type: http
    http:
      method: DELETE
      url: https://api.tinybird.co/v0/pipes/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Delete a pipe and all its nodes.
  - info:
      name: Create Pipe Node
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/pipes/:name/nodes
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Add a new SQL node to an existing pipe.
  - info:
      name: Update Pipe Node
      type: http
    http:
      method: PUT
      url: https://api.tinybird.co/v0/pipes/:name/nodes/:nodeId
      params:
      - name: name
        value: ''
        type: path
      - name: nodeId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an existing pipe node's SQL or description.
  - info:
      name: Delete Pipe Node
      type: http
    http:
      method: DELETE
      url: https://api.tinybird.co/v0/pipes/:name/nodes/:nodeId
      params:
      - name: name
        value: ''
        type: path
      - name: nodeId
        value: ''
        type: path
    docs: Delete a specific node from a pipe.
  - info:
      name: Explain Pipe Query
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/pipes/:name/explain
      params:
      - name: name
        value: ''
        type: path
    docs: Get the query execution plan for a pipe.
- info:
    name: Query
    type: folder
  items:
  - info:
      name: Execute SQL Query (GET)
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/sql
      params:
      - name: q
        value: ''
        type: query
        description: SQL query string to execute
      - name: format
        value: ''
        type: query
        description: Output format
    docs: Execute a SQL query using the Tinybird query engine via GET request.
  - info:
      name: Execute SQL Query (POST)
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/sql
      body:
        type: json
        data: '{}'
    docs: Execute a SQL query using the Tinybird query engine via POST request, supporting templated queries.
- info:
    name: Tokens
    type: folder
  items:
  - info:
      name: List Tokens
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/tokens/
    docs: Retrieve all workspace static tokens.
  - info:
      name: Create Token
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/tokens/
      body:
        type: json
        data: '{}'
    docs: Create a new static or JWT token with specified scopes and permissions.
  - info:
      name: Get Token
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/tokens/:tokenId
      params:
      - name: tokenId
        value: ''
        type: path
    docs: Fetch information about a particular static token.
  - info:
      name: Update Token
      type: http
    http:
      method: PUT
      url: https://api.tinybird.co/v0/tokens/:tokenId
      params:
      - name: tokenId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Modify an existing static token's properties and scopes.
  - info:
      name: Delete Token
      type: http
    http:
      method: DELETE
      url: https://api.tinybird.co/v0/tokens/:tokenId
      params:
      - name: tokenId
        value: ''
        type: path
    docs: Remove a static token, immediately revoking its access.
  - info:
      name: Refresh Token
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/tokens/:tokenId/refresh
      params:
      - name: tokenId
        value: ''
        type: path
    docs: Refresh a static token's value while preserving all other attributes.
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: List Jobs
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/jobs/
      params:
      - name: status
        value: ''
        type: query
        description: Filter jobs by status
      - name: kind
        value: ''
        type: query
        description: Filter jobs by type
    docs: Retrieve job history from the past 48 hours or last 100 jobs.
  - info:
      name: Get Job
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/jobs/:jobId
      params:
      - name: jobId
        value: ''
        type: path
    docs: Retrieve details about a specific job.
- info:
    name: Analyze
    type: folder
  items:
  - info:
      name: Analyze File Schema
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/analyze
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
    docs: Analyze a given NDJSON, CSV, or Parquet file to generate a Tinybird Data Source schema.
- info:
    name: Environment Variables
    type: folder
  items:
  - info:
      name: List Environment Variables
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/env_vars
    docs: List all environment variables in the workspace.
  - info:
      name: Create Environment Variable
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/env_vars
      body:
        type: json
        data: '{}'
    docs: Create a new environment variable for use within pipes.
  - info:
      name: Update Environment Variable
      type: http
    http:
      method: PUT
      url: https://api.tinybird.co/v0/env_vars/:name
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an existing environment variable's value.
  - info:
      name: Delete Environment Variable
      type: http
    http:
      method: DELETE
      url: https://api.tinybird.co/v0/env_vars/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Delete an environment variable from the workspace.
- info:
    name: Sink Pipes
    type: folder
  items:
  - info:
      name: List Sink Pipes
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/sink_pipes
    docs: List all sink pipes in the workspace.
  - info:
      name: Create Sink Pipe
      type: http
    http:
      method: POST
      url: https://api.tinybird.co/v0/sink_pipes
      body:
        type: json
        data: '{}'
    docs: Create a new sink pipe with scheduling and triggering capabilities.
- info:
    name: Organizations
    type: folder
  items:
  - info:
      name: List Organizations
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/organizations
    docs: List all organizations the authenticated user belongs to.
  - info:
      name: List Organization Members
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/organizations/:orgId/members
      params:
      - name: orgId
        value: ''
        type: path
    docs: List all members in an organization.
  - info:
      name: List Organization Workspaces
      type: http
    http:
      method: GET
      url: https://api.tinybird.co/v0/organizations/:orgId/workspaces
      params:
      - name: orgId
        value: ''
        type: path
    docs: List all workspaces in an organization.
bundled: true