Viam

Viam Modules API

Modular component and service lifecycle.

GitHub OpenAPI

Operations 2

POST /viam.robot.v1.RobotService/GetModelsFromModules Viam Get Models From Modules #
POST /viam.robot.v1.RobotService/RestartModule Viam Restart Module #

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-modules-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-modules-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-modules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Viam Machine Management Modules API
  description: 'REST/JSON transcoding of the Viam RobotService gRPC API. Connect to a viam-server

    instance running on a device to inspect resources, manage sessions, retrieve status,

    transform poses, and tunnel TCP traffic.


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

    '
  version: '2026.05'
  contact:
    name: Viam Support
    url: https://www.viam.com/contact
servers:
- url: https://{machine_address}
  description: Per-machine viam-server endpoint (typically resolved through app.viam.com signaling)
  variables:
    machine_address:
      default: machine.local.viam.cloud:443
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 sent as gRPC metadata or location secret.