Workloads

Create a workload

Register a new workload (a connector that streams agent/workflow run metadata into Dobby). The tenant is derived from the API key. For platform=dobby_sdk with no credentials supplied, the server mints a dsdk_ bearer token and returns it ONCE in bearer_token — store it, it cannot be retrieved later.

post/api/v1/workloads

Request

  • Base URL: http://dobby-ai.com
  • URL: http://dobby-ai.com/api/v1/workloads
  • Auth: HTTP bearer

Request body

display_namestring required

Human-friendly name shown on the Workloads page

platform'dobby_sdk' | 'openclaw_otlp' | 'crewai_cloud' | 'langsmith' | 'n8n' | 'github_actions' | 'airflow' | 'snowflake' | 'databricks' | 'cursor' | 'saas'

Source platform of the workload

auth_method'api_token' | 'oauth' | 'service_account'
bearer_tokenstring

Upstream platform token (paste mode). Encrypted at rest. Omit for dobby_sdk to have one minted.

external_credentials_secret_refstring

GCP Secret Manager resource path (projects//secrets//versions/*). Alternative to bearer_token.

supports_webhookboolean
poll_interval_secondsinteger
external_account_idstring

Example request

{
  "display_name": "iOS Version Agent"
}

Response

Workload created

successboolean
bearer_tokenstring

Minted dsdk_ token — returned only once (mint mode only).

Example response

{
  "success": true,
  "workload": {
    "id": "wc_a1b2c3d4e5f6",
    "display_name": "iOS Version Agent",
    "platform": "dobby_sdk",
    "status": "pending_auth"
  },
  "bearer_token": "dsdk_0123456789abcdef0123456789abcdef"
}

Changes

No recorded changes to this operation across all 1 revision of this API.