Background Tasks

Get task artifact

Returns the markdown artifact mirrored from bg-tasks/<slug>/index.md. If no artifact exists yet, the API returns an empty body with revision 0 so the desktop can create it with PUT.

get/v1/background-tasks/{slug}/artifact

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/background-tasks/{slug}/artifact
Auth: HTTP bearer

Path parameters

slugstring required

Task slug.

Example:daily-summary

Background task slug, matching bg-tasks/<slug> locally.

Response

Task artifact.

bodystring required

Markdown artifact body for a background task.

revisioninteger required

Optimistic-lock revision used by write endpoints.

slugstring required

Stable per-user background task slug matching bg-tasks/<slug> locally.

updatedAtstring date-time required

Server timestamp for the last artifact update.

Example response

{
  "body": "# Daily Account Summary\n\nContext.",
  "revision": 2,
  "slug": "daily-summary",
  "updatedAt": "2026-06-04T20:39:00Z"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.