Viam

Viam Modules API

Modular component and service lifecycle.

Documentation GitHub OpenAPI

Documentation

https://docs.viam.com/dev/reference/apis/fleet/

https://docs.viam.com/dev/reference/apis/robot/

https://docs.viam.com/dev/reference/apis/data-client/

https://docs.viam.com/data-ai/capture-data/capture-sync/

https://docs.viam.com/data-ai/train/train-tflite/

https://docs.viam.com/services/ml/deploy/

https://docs.viam.com/manage/manage/billing/

https://docs.viam.com/services/motion/

https://docs.viam.com/services/vision/

https://docs.viam.com/services/slam/

https://docs.viam.com/dev/reference/apis/

https://docs.viam.com/data-ai/data/data-pipelines/

Specifications

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

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-organization-schema.json

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-location-schema.json

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-machine-schema.json

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-tabular-data-schema.json

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-schema/viam-binary-data-schema.json

Other Resources

https://github.com/viamrobotics/api/blob/main/proto/viam/app/v1/app.proto

https://raw.githubusercontent.com/api-evangelist/viam/refs/heads/main/json-ld/viam-context.jsonld

https://github.com/viamrobotics/api/blob/main/proto/viam/robot/v1/robot.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/app/data/v1/data.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/app/datasync/v1/data_sync.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/app/mltraining/v1/ml_training.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/app/mlinference/v1/ml_inference.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/app/v1/billing.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/service/motion/v1/motion.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/service/vision/v1/vision.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/service/slam/v1/slam.proto

https://github.com/viamrobotics/api/blob/main/proto/viam/service/mlmodel/v1/mlmodel.proto

https://github.com/viamrobotics/api/tree/main/proto/viam/component

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

OpenAPI Specification

openapi: 3.1.0
info:
  title: Viam Billing Arm Modules API
  description: 'REST/JSON transcoding of the Viam BillingService gRPC API. Retrieve current-month

    usage, invoice summaries, invoice PDFs, billing tiers, and the location-level billing

    organization assignment used by Viam''s "build a robotics business" features.


    Canonical contract: https://github.com/viamrobotics/api/blob/main/proto/viam/app/v1/billing.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: Modules
  description: Modular component and service lifecycle.
paths:
  /viam.robot.v1.RobotService/GetModelsFromModules:
    post:
      summary: Viam Get Models From Modules
      description: Retrieve the list of resource models registered by all loaded modules.
      operationId: getModelsFromModules
      tags:
      - Modules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successful response.
  /viam.robot.v1.RobotService/RestartModule:
    post:
      summary: Viam Restart Module
      description: Restart a loaded module without restarting viam-server.
      operationId: restartModule
      tags:
      - Modules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                module_id:
                  type: string
                module_name:
                  type: string
      responses:
        '200':
          description: Successful response.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: key
      description: Viam API key.