# Workload API skill

> Workload API skill - Install and use the DataRobot Workload API skill in third-party coding agents
> such as Claude Code, Cursor, OpenCode, and VS Code Copilot.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-07-09T05:46:40.347278+00:00` (UTC).

## Primary page

- [Workload API skill](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md): Full documentation for this topic (Markdown sidecar).

## Sections on this page

- [Install the skill](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#install-the-skill): In-page section heading.
- [Verify installation](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#verify-installation): In-page section heading.
- [Configure your environment](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#configure-your-environment): In-page section heading.
- [Use the skill in your coding agent](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#use-the-skill): In-page section heading.
- [Deploy, configure, and scale](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#deploy-configure-scale): In-page section heading.
- [Diagnose failures](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#diagnose-failures): In-page section heading.
- [Observe running Workloads](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#observe): In-page section heading.
- [Manage the artifact lifecycle](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#artifact-lifecycle): In-page section heading.
- [Bundled helper scripts](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#helper-scripts): In-page section heading.
- [Related skills](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/workload-api-skill.html.md#related-skills): In-page section heading.

## Related documentation

- [Workload API](https://docs.datarobot.com/en/docs/workload-api/index.html.md): Linked from this page.
- [Get started: Workload API](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/index.html.md): Linked from this page.
- [DataRobot agentic skills](https://docs.datarobot.com/en/docs/agentic-ai/agentic-develop/agentic-skills.html.md): Linked from this page.

## Documentation content

> [!NOTE] Preview
> The Workload API is a preview feature, on by default.
> 
> Feature flag: Enable Access to Workload API Experimental Features

The Workload API skill ( `datarobot-workload-api`) packages Workload API knowledge and operational workflows for use inside third-party coding agents. Instead of consulting reference documentation while you work, you describe what you want in natural language and the skill guides your coding agent through the correct API calls, debugging steps, and lifecycle decisions.

The skill can be found in the [DataRobot Agentic Skills repository](https://github.com/datarobot-oss/datarobot-agent-skills) alongside other DataRobot skills. It covers four operational areas: deploying and scaling Workloads, diagnosing failures, observing running Workloads, and managing the artifact lifecycle from draft to production rollout.

## Install the skill

Install all DataRobot skills (including the Workload API skill and the required `datarobot-setup` skill) with the [universal skills installer](https://github.com/skillcreatorai/Ai-Agent-Skills):

```
npx ai-agent-skills install datarobot-oss/datarobot-agent-skills
```

By default, the installer copies skills to all supported coding agents on your machine. To target a specific agent, add the `--agent` flag:

```
npx ai-agent-skills install datarobot-oss/datarobot-agent-skills --agent cursor
npx ai-agent-skills install datarobot-oss/datarobot-agent-skills --agent claude
```

You can also install from agent-specific marketplaces or extension catalogs:

| Agent | Install surface |
| --- | --- |
| Claude Code | claude.com/plugins/datarobot-agent-skills |
| Cursor | cursor.com/marketplace/datarobot |
| Gemini CLI | geminicli.com/extensions |
| Skills repository | github.com/datarobot-oss/datarobot-agent-skills |

For agent-specific installation details and the full list of supported agents, see [DataRobot agentic skills](https://docs.datarobot.com/en/docs/agentic-ai/agentic-develop/agentic-skills.html.md).

### Verify installation

After installing, ask your coding agent `What DataRobot skills do I have available?`.

You should see `datarobot-setup` and `datarobot-workload-api` listed. The skill source and helper scripts are in [skills/datarobot-workload-api/](https://github.com/datarobot-oss/datarobot-agent-skills/tree/main/skills/datarobot-workload-api) in the repository.

## Configure your environment

Before working with Workloads, run the `datarobot-setup` skill once per workspace. It checks Python and other dependencies, configures your DataRobot API token, and sets `DATAROBOT_ENDPOINT` and `DATAROBOT_API_TOKEN` for the session.

Trigger setup with either:

- Type: Run datarobot-setup
- Or use the slash command: ./datarobot-setup

Accept the prompts to complete environment configuration. If setup runs again in a later session, allow it to ensure the prerequisites are current.

## Use the skill in your coding agent

The skill activates automatically when you describe a Workload API task in natural language. You do not need to use a slash command or explicitly name the skill. The skill covers four areas:

### Deploy, configure, and scale

Describe what you want to run and the skill handles artifact and Workload creation, environment variable injection, compute bundle selection, and autoscaling configuration.

Example prompts:

- "Deploy ghcr.io/my-org/my-app:latest as a Workload on DataRobot listening on port 8000."
- "Scale my agent-service Workload to 3 replicas and enable CPU autoscaling."
- "Change the importance on prod-llm to critical ."
- "Inject my S3 credential into the data-pipeline Workload as AWS_ACCESS_KEY_ID ."

### Diagnose failures

When a Workload is stuck, errored, or crash-looping, the skill runs a structured diagnosis across Workload status, lifecycle events, proton state, and per-replica container conditions, then recommends a fix.

Example prompts:

- "My rag-service Workload is stuck in launching . What's wrong?"
- "Debug the CrashLoopBackOff on inference-server ."
- "Why is my Workload failing with ImagePullBackOff ?"

### Observe running Workloads

Pull logs, traces, metrics, and service statistics from a running Workload. The skill knows the OTel observability surface endpoints and the Workload API stats surface, and applies the correct unit conversions before presenting results.

Example prompts:

- "Show me the last 100 error logs from llm-gateway ."
- "Which traces on agent-service had errors in the last hour?"
- "What's the request error rate and p50 latency on prod-api ?"

### Manage the artifact lifecycle

Iterate draft artifacts, lock them for production, and roll out new container versions to running Workloads with zero downtime.

Example prompts:

- "Lock the artifact behind staging-api and promote it to production."
- "Roll out ghcr.io/my-org/my-app:v2 to prod-api using a rolling replacement."
- "Clone the artifact on llm-service , update the image tag to :v3 , and start a replacement."

## Bundled helper scripts

The skill includes Python scripts in `skills/datarobot-workload-api/scripts/` that your coding agent can run directly:

| Script | Purpose |
| --- | --- |
| wait_for_running.py <workload_id> | Poll until running; exits non-zero on terminal failure or timeout. |
| diagnose_workload.py <workload_id> | Run the full 5-step debug flow and print a structured diagnosis. Add --json for machine-readable output. |
| wait_for_build.py <artifact_id> <build_id> | Poll a server-side image build; dumps the last 2 KB of logs on failure. |
| wait_for_replacement.py <workload_id> | Poll a rolling replacement to completion. |
| check_limits.py | Print the effective org-set concurrency and replica limits. |

All scripts read `DATAROBOT_ENDPOINT` and `DATAROBOT_API_TOKEN` from the environment.

## Related skills

| Skill | Purpose |
| --- | --- |
| datarobot-setup | Install the DataRobot SDK, configure auth, and set environment variables. Required before using this skill. |
| datarobot-app-framework-cicd | Declarative artifact and Workload management via Pulumi and CI/CD pipelines. |
| datarobot-external-agent-monitoring | Instrument arbitrary agent code with OpenTelemetry and route telemetry to DataRobot. |