Viam

Viam Pipelines API

Scheduled MQL aggregation pipelines.

GitHub OpenAPI

Operations 8

POST /viam.app.datapipelines.v1.DataPipelinesService/GetDataPipeline Viam Get Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/ListDataPipelines Viam List Data Pipelines #
POST /viam.app.datapipelines.v1.DataPipelinesService/CreateDataPipeline Viam Create Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/RenameDataPipeline Viam Rename Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/DeleteDataPipeline Viam Delete Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/EnableDataPipeline Viam Enable Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/DisableDataPipeline Viam Disable Data Pipeline #
POST /viam.app.datapipelines.v1.DataPipelinesService/ListDataPipelineRuns Viam List Data Pipeline Runs #

Documentation

📖
Documentation
https://docs.viam.com/dev/reference/apis/fleet/
📖
Documentation
https://docs.viam.com/dev/reference/apis/robot/
📖
Documentation
https://docs.viam.com/dev/reference/apis/data-client/
📖
Documentation
https://docs.viam.com/data-ai/capture-data/capture-sync/
📖
Documentation
https://docs.viam.com/data-ai/train/train-tflite/
📖
Documentation
https://docs.viam.com/services/ml/deploy/
📖
Documentation
https://docs.viam.com/manage/manage/billing/
📖
Documentation
https://docs.viam.com/services/motion/
📖
Documentation
https://docs.viam.com/services/vision/
📖
Documentation
https://docs.viam.com/services/slam/
📖
Documentation
https://docs.viam.com/dev/reference/apis/
📖
Documentation
https://docs.viam.com/data-ai/data/data-pipelines/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/openapi/viam-pipelines-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-organization-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-machine-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-tabular-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-binary-data-schema.json

Other Resources

🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/v1/app.proto
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-ld/viam-context.jsonld
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/robot/v1/robot.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/data/v1/data.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/datasync/v1/data_sync.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/mltraining/v1/ml_training.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/mlinference/v1/ml_inference.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/v1/billing.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/service/motion/v1/motion.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/service/vision/v1/vision.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/service/slam/v1/slam.proto
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/service/mlmodel/v1/mlmodel.proto
🔗
Protobuf
https://github.com/viamrobotics/api/tree/main/proto/viam/component
🔗
Protobuf
https://github.com/viamrobotics/api/blob/main/proto/viam/app/datapipelines/v1/data_pipelines.proto

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/viam-pipelines-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

viam-pipelines-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Viam Data Pipelines API
  description: 'REST/JSON transcoding of the Viam DataPipelinesService gRPC API. Create, list, rename,

    enable, disable, and delete scheduled MQL data pipelines that aggregate captured

    machine data into the Viam hot data store.


    Canonical contract: https://github.com/viamrobotics/api/blob/main/proto/viam/app/datapipelines/v1/data_pipelines.proto

    '
  version: '2026.05'
  contact:
    name: Viam Support
    url: https://www.viam.com/contact
servers:
- url: https://app.viam.com
  description: Viam production cloud.
security:
- ApiKeyAuth: []
tags:
- name: Pipelines
  description: Scheduled MQL aggregation pipelines.
paths:
  /viam.app.datapipelines.v1.DataPipelinesService/GetDataPipeline:
    post:
      summary: Viam Get Data Pipeline
      description: Retrieve a data pipeline by id.
      operationId: getDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/ListDataPipelines:
    post:
      summary: Viam List Data Pipelines
      description: List data pipelines in an organization.
      operationId: listDataPipelines
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - organization_id
              properties:
                organization_id:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/CreateDataPipeline:
    post:
      summary: Viam Create Data Pipeline
      description: Create a new MQL data pipeline.
      operationId: createDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - organization_id
              - name
              - mql_binary
              - schedule
              properties:
                organization_id:
                  type: string
                name:
                  type: string
                mql_binary:
                  type: array
                  items:
                    type: string
                    format: byte
                schedule:
                  type: string
                  description: Cron expression
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/RenameDataPipeline:
    post:
      summary: Viam Rename Data Pipeline
      description: Rename a data pipeline.
      operationId: renameDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              - name
              properties:
                id:
                  type: string
                name:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/DeleteDataPipeline:
    post:
      summary: Viam Delete Data Pipeline
      description: Delete a data pipeline.
      operationId: deleteDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/EnableDataPipeline:
    post:
      summary: Viam Enable Data Pipeline
      description: Enable a paused data pipeline.
      operationId: enableDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/DisableDataPipeline:
    post:
      summary: Viam Disable Data Pipeline
      description: Disable a running data pipeline.
      operationId: disableDataPipeline
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.app.datapipelines.v1.DataPipelinesService/ListDataPipelineRuns:
    post:
      summary: Viam List Data Pipeline Runs
      description: List historical runs for a data pipeline.
      operationId: listDataPipelineRuns
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                page_size:
                  type: integer
                page_token:
                  type: string
      responses:
        '200':
          description: Successful response.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: key
      description: Viam API key.