Live Direct Marketing

Live Direct Marketing Workers API

The workers API from Live Direct Marketing — 5 operation(s) for workers.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/workers/jobs/claim Claim the next worker job · Workers controller claim #
Ask an LLM
“How does a worker pick up its next job from the queue?”
“Where does a background worker claim work?”
Tell an agent
Claim the next available worker job.
Grab a job from the worker queue.
POST /api/workers/jobs/{id}/heartbeat Send a heartbeat for a running worker job · Workers controller heartbeat #
Ask an LLM
“How does a worker show a long job is still running?”
“Can a worker keep its claim on a job alive?”
Tell an agent
Send a heartbeat for worker job {id}.
Keep job {id} alive.
POST /api/workers/jobs/{id}/screenshot Upload a screenshot for a worker job · Workers controller upload screenshot #
Ask an LLM
“How does a worker attach a screenshot to a job?”
“Can I tag a job screenshot with its placement and variant?”
Tell an agent
Upload a screenshot for job {id}.
Attach the {placement} screenshot, variant {variant}, to job {id}.
POST /api/workers/jobs/{id}/complete Mark a worker job complete · Workers controller complete #
Ask an LLM
“How does a worker report that a job finished successfully?”
“Where do I submit a completed job's result?”
Tell an agent
Mark worker job {id} complete.
Report job {id} as finished.
POST /api/workers/jobs/{id}/fail Mark a worker job failed · Workers controller fail #
Ask an LLM
“How does a worker report that a job failed?”
“Can a worker give up on a job it claimed?”
Tell an agent
Mark worker job {id} as failed.
Report a failure on job {id}.

Documentation

📖
Documentation
https://developers.live-direct-marketing.online/
📖
APIReference
https://developers.live-direct-marketing.online/api-reference
📖
GettingStarted
https://developers.live-direct-marketing.online/quickstart
📖
Authentication
https://developers.live-direct-marketing.online/authentication
📖
Documentation
https://check.live-direct-marketing.online/docs
📖
APIReference
https://check.live-direct-marketing.online/api/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/openapi/live-direct-marketing-online-workers-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/data-model/live-direct-marketing-online-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/live-direct-marketing-online:live-direct-marketing-online-workers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

live-direct-marketing-online-workers-api-openapi.yml Raw ↑ 
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