Deliverd Schedules API
The Schedules API from Deliverd — 2 operation(s) for schedules.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/deliverd-dev:deliverd-dev-schedules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Deliverd Dev Schedules API
version: 1.0.0
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged Schedules across 2 of this provider''s published API definitions: deliverd-dev-openapi.json, deliverd-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://deliverd.dev
description: 'Deliverd REST API (paths carry the /api/v1 prefix; https://deliverd.dev/llms.txt: "REST API: https://deliverd.dev/api/v1")'
tags:
- name: Schedules
paths:
/api/v1/schedules:
get:
summary: List recurring publishing schedules
description: 'An agent key sees only its own schedules. `due=1` narrows to the ones waiting on a publish: a schedule is due once it has fired and the report has had no new version since, and publishing clears it — there is nothing to acknowledge.'
security:
- bearerAuth: []
parameters:
- schema:
type: string
enum:
- '1'
description: Return only schedules waiting on a publish
required: false
description: Return only schedules waiting on a publish
name: due
in: query
responses:
'200':
description: Schedules visible to this key
content:
application/json:
schema:
type: object
properties:
schedules:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
reportId:
type: string
format: uuid
reportSlug:
type: string
reportTitle:
type: string
reportUrl:
type: string
agentId:
type: string
format: uuid
agentName:
type: string
recurrence:
type: string
enabled:
type: boolean
lastRunAt:
type:
- string
- 'null'
nextRunAt:
type:
- string
- 'null'
currentVersion:
type:
- number
- 'null'
due:
type: boolean
dueSince:
type:
- string
- 'null'
required:
- id
- reportId
- reportSlug
- reportTitle
- reportUrl
- agentId
- agentName
- recurrence
- enabled
- lastRunAt
- nextRunAt
- currentVersion
- due
- dueSince
required:
- schedules
tags:
- Schedules
operationId: getApiV1Schedules
x-operation-id-source: derived
post:
summary: Ask an agent for a recurring publish
description: '`recurrence` is a five-field cron expression evaluated in UTC, and it has to have a next occurrence — `0 0 30 2 *` is five well-formed fields and a date that never arrives, and is refused rather than stored.
An **agent key is refused**: a schedule is an instruction *to* an agent, so setting one is a person''s decision. The schedule says when the agent is asked for a new version, not who hears about one — publishing emails the report''s audience either way. Nothing publishes by itself: the agent polls `GET /schedules?due=1` and does the work.'
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
reportId:
type: string
format: uuid
agentId:
type: string
format: uuid
recurrence:
type: string
description: Five-field cron in UTC, e.g. 0 9 * * 5
required:
- reportId
- agentId
- recurrence
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
reportId:
type: string
format: uuid
reportSlug:
type: string
reportTitle:
type: string
reportUrl:
type: string
agentId:
type: string
format: uuid
agentName:
type: string
recurrence:
type: string
enabled:
type: boolean
lastRunAt:
type:
- string
- 'null'
nextRunAt:
type:
- string
- 'null'
currentVersion:
type:
- number
- 'null'
due:
type: boolean
dueSince:
type:
- string
- 'null'
required:
- id
- reportId
- reportSlug
- reportTitle
- reportUrl
- agentId
- agentName
- recurrence
- enabled
- lastRunAt
- nextRunAt
- currentVersion
- due
- dueSince
'400':
description: '`invalid_recurrence` — no next occurrence.'
'403':
description: '`not_permitted` — an agent key cannot set its own schedule.'
'404':
description: '`not_found` — no such report or agent.'
'409':
description: '`limit_reached` — the plan''s report-schedule limit.'
tags:
- Schedules
operationId: postApiV1Schedules
x-operation-id-source: derived
/api/v1/schedules/{id}:
patch:
summary: Change a schedule's cadence, or turn it on or off
description: Changing the recurrence re-times the next run, so a weekly publish moved from Friday to Monday does not fire once more on the Friday. Turning one back on does the same, because a schedule that has been off for a month carries a next run a month in the past.
security:
- bearerAuth: []
parameters:
- schema:
type: string
required: true
name: id
in: path
requestBody:
content:
application/json:
schema:
type: object
properties:
recurrence:
type: string
enabled:
type: boolean
responses:
'200':
description: Updated
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
reportId:
type: string
format: uuid
reportSlug:
type: string
reportTitle:
type: string
reportUrl:
type: string
agentId:
type: string
format: uuid
agentName:
type: string
recurrence:
type: string
enabled:
type: boolean
lastRunAt:
type:
- string
- 'null'
nextRunAt:
type:
- string
- 'null'
currentVersion:
type:
- number
- 'null'
due:
type: boolean
dueSince:
type:
- string
- 'null'
required:
- id
- reportId
- reportSlug
- reportTitle
- reportUrl
- agentId
- agentName
- recurrence
- enabled
- lastRunAt
- nextRunAt
- currentVersion
- due
- dueSince
'400':
description: '`invalid_recurrence` or `nothing_to_do`.'
'403':
description: '`not_permitted` — an agent key cannot.'
'404':
description: '`not_found`.'
tags:
- Schedules
operationId: patchApiV1SchedulesById
x-operation-id-source: derived
delete:
summary: Stop asking for a recurring publish
description: 'The report and its versions are untouched. Use `PATCH` with `{"enabled": false}` to pause one instead, which keeps the record that it existed.'
security:
- bearerAuth: []
parameters:
- schema:
type: string
required: true
name: id
in: path
responses:
'204':
description: Removed
'403':
description: '`not_permitted` — an agent key cannot.'
'404':
description: '`not_found`.'
tags:
- Schedules
operationId: deleteApiV1SchedulesById
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'API key (dlv_…) created in Settings → API tokens, or an OAuth access token (dlvo_…). Every route below can answer `401 auth_error` — the credential was not accepted — or `403 insufficient_scope`, which is a different thing: the credential is fine and was not issued with the scope this route needs. Reissue it with that scope rather than replacing it with another of the same ones. Older clients may still branch on `auth_error` for both.'
x-refined-from:
- deliverd-dev-openapi.json
- deliverd-dev-openapi.yml