openapi.yaml

openapi: 3.1.0
info:
  title: Agent Run Protocol
  description: |
    Open standard for agent observability. Any agent runtime can report runs
    to any compliant server. Mission Control is the reference implementation.
  version: 0.1.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  contact:
    name: Builderz Labs
    url: https://github.com/builderz-labs/agent-run

servers:
  - url: http://localhost:3000/api/v1
    description: Local Mission Control instance

paths:
  /runs:
    post:
      operationId: createRun
      summary: Report a new agent run
      description: |
        Called by agent runtimes to report a completed (or in-progress) run.
        The server validates the run against the AgentRun schema and stores it.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRun'
      responses:
        '201':
          description: Run created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id: { type: string }
                  run_hash: { type: string }
        '400':
          description: Invalid run data
        '401':
          description: Unauthorized

    get:
      operationId: listRuns
      summary: List agent runs
      parameters:
        - name: agent_id
          in: query
          schema: { type: string }
        - name: status
          in: query
          schema: { type: string, enum: [pending, running, completed, failed, cancelled, timeout] }
        - name: since
          in: query
          schema: { type: string, format: date-time }
        - name: limit
          in: query
          schema: { type: integer, default: 50, maximum: 200 }
        - name: offset
          in: query
          schema: { type: integer, default: 0 }
      responses:
        '200':
          description: List of runs
          content:
            application/json:
              schema:
                type: object
                properties:
                  runs:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentRun'
                  total: { type: integer }

  /runs/{run_id}:
    get:
      operationId: getRun
      summary: Get a single run by ID
      parameters:
        - name: run_id
          in: path
          required: true
          schema: { type: string }
      responses:
        '200':
          description: The run
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRun'
        '404':
          description: Run not found

  /runs/{run_id}/provenance:
    get:
      operationId: getRunProvenance
      summary: Get the provenance record for a run
      description: |
        Returns the cryptographic provenance chain for a run, including
        lineage hashes and optional signature. Used for audit trails.
      parameters:
        - name: run_id
          in: path
          required: true
          schema: { type: string }
      responses:
        '200':
          description: Provenance record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Provenance'
        '404':
          description: Run not found

  /runs/{run_id}/eval:
    put:
      operationId: setRunEval
      summary: Attach or update an eval result for a run
      description: |
        Eval results can be attached after the run completes. This allows
        separate eval pipelines to score runs independently.
      parameters:
        - name: run_id
          in: path
          required: true
          schema: { type: string }
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvalResult'
      responses:
        '200':
          description: Eval attached
        '404':
          description: Run not found

  /runs/stream:
    get:
      operationId: streamRuns
      summary: Server-Sent Events stream of new runs
      description: |
        Real-time stream of AgentRun events as they are created or updated.
        Useful for dashboards and monitoring.
      responses:
        '200':
          description: SSE stream
          content:
            text/event-stream:
              schema:
                type: string

  /evals/leaderboard:
    get:
      operationId: getLeaderboard
      summary: Get eval leaderboard
      parameters:
        - name: benchmark_id
          in: query
          schema: { type: string }
        - name: limit
          in: query
          schema: { type: integer, default: 50 }
      responses:
        '200':
          description: Leaderboard entries
          content:
            application/json:
              schema:
                type: object
                properties:
                  entries:
                    type: array
                    items:
                      type: object
                      properties:
                        agent_name: { type: string }
                        model: { type: string }
                        runtime: { type: string }
                        avg_score: { type: number }
                        pass_rate: { type: number }
                        avg_cost_usd: { type: number }
                        run_count: { type: integer }

components:
  schemas:
    AgentRun:
      $ref: 'agent-run.json'
    Step:
      $ref: 'step.json'
    Cost:
      $ref: 'cost.json'
    Provenance:
      $ref: 'provenance.json'
    EvalResult:
      $ref: 'eval.json'

  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key issued by the agent-run server
    bearer:
      type: http
      scheme: bearer
      description: Bearer token authentication

security:
  - apiKey: []
  - bearer: []