---
title: "Create a workload"
method: POST
path: "/api/v1/workloads"
tags: ["Workloads"]
---

# Create a workload

`POST /api/v1/workloads`

## Request

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

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.

## Request body

- object
  - `display_name` string, 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_token` string: Upstream platform token (paste mode). Encrypted at rest. Omit for dobby_sdk to have one minted.
  - `external_credentials_secret_ref` string: GCP Secret Manager resource path (projects/*/secrets/*/versions/*). Alternative to bearer_token.
  - `supports_webhook` boolean
  - `poll_interval_seconds` integer
  - `external_account_id` string

## Response `201`

Workload created

- object
  - `success` boolean
  - `workload` object
    - `id` string
    - `display_name` string
    - `platform` string
    - `status` string
  - `bearer_token` string: Minted dsdk_ token — returned only once (mint mode only).

## Other responses

- `400`: Bad Request - Invalid parameters
- `401`: Unauthorized - Missing or invalid authentication
- `403`: Forbidden - Missing required scope
- `404`: Not Found - Resource does not exist
- `429`: Too Many Requests - Rate limit exceeded

---

[API](https://skmtc.dev/dobby-ai/apis/dobby-platform-api.md) · [All operations](https://skmtc.dev/dobby-ai/apis/dobby-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dobby-ai/apis/dobby-platform-api/revisions/398634f0306f?raw)