Sign in
Background Tasks

Get background task template

Fetches one built-in task template by slug so clients can preview the instructions, default trigger, and required connectors before instantiation.

get/v1/background-task-templates/{templateSlug}

Request

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

Path parameters

templateSlugstring required

Template slug.

Example:inbox-digest

Background task template slug.

Response

Task template.

activeboolean required

Whether instantiated tasks are active by default.

descriptionstring required

Short explanation of what the template does.

executionTarget'api' | 'desktop' required

Default execution target.

firstPartyboolean required

Whether the template is installed and maintained automatically by Oppulence.

instructionsstring required

Default task instructions.

modelstring nullable

Default model id for runs.

namestring required

Default task name.

providerstring nullable

Default provider for tasks created from this template.

requiredConnectorsstring[]

Connectors this template expects for full fidelity.

slugstring required

Stable template slug.

tagsstring[]

Template tags for UI grouping.

taskSlugstring required

Default task slug used when instantiating this template.

triggersunknown
versioninteger required

Monotonic product definition version used for safe upgrades.

Example response

{
  "active": true,
  "description": "Summarize new priority email and produce a short follow-up plan.",
  "executionTarget": "api",
  "instructions": "Review recent important Gmail messages and produce a markdown digest.",
  "model": "anthropic/claude-sonnet-4-5",
  "name": "Inbox Digest",
  "provider": "openrouter",
  "requiredConnectors": [
    "google"
  ],
  "slug": "inbox-digest",
  "tags": [
    "gmail"
  ],
  "taskSlug": "inbox-digest",
  "triggers": {
    "cronExpr": "0 9 * * *",
    "timezone": "America/New_York"
  },
  "version": 1
}

Changes

No operation changes recorded.