openapi: 3.2.0
info:
  title: inbox-check Workers API
  description: Email deliverability test API for AI agents and automation. Same surface is exposed via REST (here), MCP (streamable-http at /mcp), and A2A (skill manifest at /.well-known/agent.json).
  version: 1.0.0
  contact: {}
servers: []
tags:
- name: Workers
paths:
  /api/workers/jobs/claim:
    post:
      operationId: WorkersController_claim
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimDto'
      responses:
        '200':
          description: ''
      security:
      - adminKey: []
      tags:
      - Workers
      summary: Workers controller claim
      x-summary-source: derived
  /api/workers/jobs/{id}/heartbeat:
    post:
      operationId: WorkersController_heartbeat
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - adminKey: []
      tags:
      - Workers
      summary: Workers controller heartbeat
      x-summary-source: derived
  /api/workers/jobs/{id}/screenshot:
    post:
      operationId: WorkersController_uploadScreenshot
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: placement
        required: false
        in: query
        schema:
          type: string
      - name: variant
        required: false
        in: query
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - adminKey: []
      tags:
      - Workers
      summary: Workers controller upload screenshot
      x-summary-source: derived
  /api/workers/jobs/{id}/complete:
    post:
      operationId: WorkersController_complete
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - adminKey: []
      tags:
      - Workers
      summary: Workers controller complete
      x-summary-source: derived
  /api/workers/jobs/{id}/fail:
    post:
      operationId: WorkersController_fail
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FailDto'
      responses:
        '201':
          description: ''
      security:
      - adminKey: []
      tags:
      - Workers
      summary: Workers controller fail
      x-summary-source: derived
components:
  schemas:
    ClaimDto:
      type: object
      properties: {}
    FailDto:
      type: object
      properties: {}
  securitySchemes:
    apiKey:
      scheme: bearer
      bearerFormat: icp_live_*
      type: http
    adminKey:
      type: apiKey
      in: header
      name: X-Admin-Key