Sign in
Background Tasks

Put task artifact

Creates or updates the markdown artifact mirror. Updates require the current artifact revision; creation can omit revision or send revision 0.

put/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.

Request body

bodystring required

Full markdown body to store.

revisioninteger

Current artifact revision. Required for updates to an existing artifact.

Example request

{
  "body": "# Daily Account Summary\n\nUpdated context.",
  "revision": 2
}

Response

Saved 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.