> ## Documentation Index
> Fetch the complete documentation index at: https://servo.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Register a robot



## OpenAPI

````yaml /api-reference/openapi.json post /v1/robots/setup
openapi: 3.1.0
info:
  title: Servo Public API
  version: 0.1.0
  description: >-
    Hosted robot policy API for robot inventory, models, deployments, and
    fleets.
servers: []
security:
  - bearerAuth: []
paths:
  /v1/robots/setup:
    post:
      tags:
        - robots
      summary: Register a robot
      operationId: setup_v1_robots_setup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RobotRegistration'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RobotSetupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    RobotRegistration:
      properties:
        name:
          type: string
          maxLength: 64
          minLength: 1
          title: Name
          description: Unique stable name for one physical robot.
        robot_type_id:
          type: string
          maxLength: 256
          minLength: 1
          title: Robot Type Id
          description: Type ID from the ready robot catalog or a validated custom manifest.
        region:
          type: string
          title: Region
          description: AWS region code nearest the physical robot.
        site:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
            - type: 'null'
          title: Site
          description: Optional site name used to select fleet members.
        labels:
          additionalProperties:
            type: string
          type: object
          maxProperties: 32
          title: Labels
          description: Optional key-value labels used to select fleet members.
        configuration_digest:
          type: string
          pattern: ^sha256:[0-9a-f]{64}$
          title: Configuration Digest
          description: Ordered SHA-256 digest of the local robot configuration files.
        contract:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Contract
          description: Normalized contract from a validated custom robot manifest.
      additionalProperties: false
      type: object
      required:
        - name
        - robot_type_id
        - region
        - configuration_digest
      title: RobotRegistration
      description: One-time or replacement installation request from a robot computer.
    RobotSetupResponse:
      properties:
        robot:
          $ref: '#/components/schemas/RobotView'
      additionalProperties: false
      type: object
      required:
        - robot
      title: RobotSetupResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RobotView:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        robot_type_id:
          type: string
          title: Robot Type Id
        region:
          type: string
          title: Region
        site:
          anyOf:
            - type: string
            - type: 'null'
          title: Site
        labels:
          additionalProperties:
            type: string
          type: object
          title: Labels
        created_at:
          type: string
          format: date-time
          title: Created At
      additionalProperties: false
      type: object
      required:
        - id
        - name
        - robot_type_id
        - region
        - created_at
      title: RobotView
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Servo organization API key
      description: >-
        Organization API key (`sk_servo_...`) or authenticated CLI session
        token.

````