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

# Agent key only: report hardware, servers, health, filtered engine metrics, and content-free request shapes



## OpenAPI

````yaml /openapi.json post /api/v1/agent/sync
openapi: 3.1.0
info:
  description: >-
    Durable, authenticated control-plane operations. Mutation responses may
    outlive the requesting client.
  title: InferCrane Control API
  version: 1.0.0
servers:
  - description: Local InferCrane API and gateway
    url: http://127.0.0.1:18000
security: []
tags:
  - name: Admission
  - name: Adoption
  - name: Agents
  - name: Alerts
  - name: Async inference
  - name: Audit
  - name: Autopilot
  - name: Benchmarks
  - name: Billing
  - name: Billing administration
  - name: Burst Guard
  - name: Capacity intelligence
  - name: Compute
  - name: Context Passport
  - name: Deployments
  - name: Diagnostics
  - name: Endpoints
  - name: External capacity
  - name: FinOps
  - name: Identity
  - name: Inference
  - name: Inference Lab
  - name: Inference decisions
  - name: Inference optimization
  - name: Infrastructure
  - name: Marketplace administration
  - name: Model API administration
  - name: Model APIs
  - name: Model artifacts
  - name: Model catalog
  - name: Monitoring
  - name: Notifications
  - name: Operations
  - name: Planning
  - name: Providers
  - name: Recipes
  - name: Release Guard
  - name: Release evidence
  - name: Replay
  - name: Revisions
  - name: Routing
  - name: Sandboxes
  - name: Scaling
  - name: Secrets
  - name: System
  - name: Targets
  - name: Training lineage
paths:
  /api/v1/agent/sync:
    post:
      tags:
        - Agents
      summary: >-
        Agent key only: report hardware, servers, health, filtered engine
        metrics, and content-free request shapes
      operationId: syncAgent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentSyncRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSyncResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Typed API error
      security:
        - bearerAuth: []
components:
  schemas:
    AgentSyncRequest:
      additionalProperties: true
      description: >-
        One agent sync. May be gzip-encoded; at most 8 MiB decompressed. Unknown
        fields are ignored within one protocol version.
      properties:
        agent_version:
          maxLength: 256
          type: string
        arch:
          maxLength: 256
          type: string
        gateway:
          additionalProperties: true
          type: object
        hardware:
          additionalProperties: true
          type: object
        metrics:
          description: >-
            Per server: the newest filtered engine scrape and, when available,
            the oldest scrape of the same engine process in the trailing five
            minutes.
          items:
            additionalProperties: true
            type: object
          maxItems: 32
          type: array
        os:
          maxLength: 256
          type: string
        protocol:
          const: infercrane.agent/v1
          type: string
        sent_at:
          description: Agent clock; used to correct request-shape times for clock skew.
          format: date-time
          type: string
        servers:
          items:
            additionalProperties: true
            properties:
              active_model:
                type: string
              address:
                type: string
              authenticated:
                type: boolean
              engine:
                enum:
                  - vllm
                  - sglang
                  - llama.cpp
                  - ollama
                  - lm-studio
                  - openai-compatible
                type: string
              engine_version:
                type: string
              health:
                enum:
                  - healthy
                  - unhealthy
                type: string
              health_detail:
                type: string
              key:
                pattern: ^[a-z0-9][a-z0-9._:-]{0,127}$
                type: string
              metrics_available:
                type: boolean
              metrics_detail:
                type: string
              models:
                items:
                  type: string
                maxItems: 64
                type: array
            required:
              - key
              - engine
              - address
              - models
              - health
              - metrics_available
              - authenticated
            type: object
          maxItems: 32
          type: array
        traffic:
          description: Content-free request shapes from the agent's local gateway.
          items:
            additionalProperties: true
            type: object
          maxItems: 1000
          type: array
      required:
        - protocol
        - agent_version
        - os
        - arch
        - sent_at
        - hardware
        - servers
      type: object
    AgentSyncResponse:
      additionalProperties: true
      properties:
        accepted:
          properties:
            measurements:
              type: integer
            requests:
              type: integer
          required:
            - measurements
            - requests
          type: object
        agent_id:
          type: string
        agent_name:
          type: string
        commands:
          description: Reserved for candidate runs; protocol v1 sends none.
          items:
            additionalProperties: true
            type: object
          maxItems: 0
          type: array
        poll_interval_seconds:
          maximum: 60
          minimum: 5
          type: integer
        rejected:
          items:
            additionalProperties: true
            type: object
          type: array
        servers:
          items:
            $ref: '#/components/schemas/AgentRegisteredServer'
          type: array
        upgrade:
          additionalProperties: true
          type: object
      required:
        - agent_id
        - agent_name
        - poll_interval_seconds
        - servers
        - accepted
        - rejected
        - upgrade
        - commands
      type: object
    ErrorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
      type: object
    AgentRegisteredServer:
      additionalProperties: true
      properties:
        endpoint:
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,62}[a-z0-9])?$
          type: string
        health:
          type: string
        key:
          pattern: ^[a-z0-9][a-z0-9._:-]{0,127}$
          type: string
        model:
          type: string
        ownership:
          type: string
        target_id:
          type: string
        traffic_detail:
          type: string
        traffic_source:
          enum:
            - none
            - agent-gateway
          type: string
      required:
        - key
        - endpoint
        - target_id
        - model
        - ownership
        - health
        - traffic_source
        - traffic_detail
      type: object
    Error:
      properties:
        category:
          type: string
        code:
          type: string
        message:
          type: string
        remediation:
          type: string
        request_id:
          type: string
        retryable:
          type: boolean
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.