Viam Camera API

openapi: 3.2.0
info:
  title: Viam Component Camera API
  description: 'REST/JSON transcoding of every Viam Component gRPC API — the hardware abstraction

    layer that lets any client speak the same uniform contract to motors, cameras, arms,

    sensors, and every other supported component class regardless of model.


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


    Every component exposes DoCommand (model-specific extension), GetStatus, and

    GetGeometries in addition to its class-specific operations.

    '
  version: '2026.05'
  contact:
    name: Viam Support
    url: https://www.viam.com/contact
servers:
- url: https://{machine_address}
  description: Per-machine viam-server endpoint.
  variables:
    machine_address:
      default: machine.local.viam.cloud:443
security:
- ApiKeyAuth: []
tags:
- name: Camera
  description: 2D image and 3D point cloud sources.
paths:
  /viam.component.camera.v1.CameraService/GetImages:
    post:
      summary: Viam Camera Get Images
      description: Capture one or more images from the camera.
      operationId: cameraGetImages
      tags:
      - Camera
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.component.camera.v1.CameraService/GetPointCloud:
    post:
      summary: Viam Camera Get Point Cloud
      description: Capture a 3D point cloud from the camera.
      operationId: cameraGetPointCloud
      tags:
      - Camera
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - mime_type
              properties:
                name:
                  type: string
                mime_type:
                  type: string
      responses:
        '200':
          description: Successful response.
  /viam.component.camera.v1.CameraService/GetProperties:
    post:
      summary: Viam Camera Get Properties
      description: Get camera intrinsics and supported MIME types.
      operationId: cameraGetProperties
      tags:
      - Camera
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
      responses:
        '200':
          description: Successful response.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: key
      description: Viam API key or location secret.