Get a Deep Research run

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02?fresh=true' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "RUNNING",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:04:40.118Z",
    "completedAt": null,
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": false }
    ],
    "output": null
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "COMPLETED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:09:52.771Z",
    "completedAt": "2026-09-22T14:09:52.771Z",
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": true },
      { "name": "Report writer", "role": "REPORT_WRITER", "done": true }
    ],
    "output": {
      "type": "REPORT",
      "reportId": "cm3kb1q7e0004l8f0z2r4m8na",
      "reportVersion": 1,
      "title": "Platform team delivery pace, June through August 2026",
      "summary": "Throughput held steady through July, then slowed in August as two large migrations absorbed the team.",
      "url": "https://app.gowindmill.com/s/acme/reports/cm3kb1q7e0004l8f0z2r4m8na/report?v=1",
      "content": "# Platform team delivery pace, June through August 2026\n\nThroughput held steady through July, then slowed in August as two large migrations absorbed the team..."
    }
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "FAILED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:03:12.090Z",
    "completedAt": "2026-09-22T14:03:12.090Z",
    "failureReason": "The run could not be started.",
    "agents": [],
    "output": null
  }
}

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02?fresh=true' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "RUNNING",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:04:40.118Z",
    "completedAt": null,
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": false }
    ],
    "output": null
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "COMPLETED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:09:52.771Z",
    "completedAt": "2026-09-22T14:09:52.771Z",
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": true },
      { "name": "Report writer", "role": "REPORT_WRITER", "done": true }
    ],
    "output": {
      "type": "REPORT",
      "reportId": "cm3kb1q7e0004l8f0z2r4m8na",
      "reportVersion": 1,
      "title": "Platform team delivery pace, June through August 2026",
      "summary": "Throughput held steady through July, then slowed in August as two large migrations absorbed the team.",
      "url": "https://app.gowindmill.com/s/acme/reports/cm3kb1q7e0004l8f0z2r4m8na/report?v=1",
      "content": "# Platform team delivery pace, June through August 2026\n\nThroughput held steady through July, then slowed in August as two large migrations absorbed the team..."
    }
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "FAILED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:03:12.090Z",
    "completedAt": "2026-09-22T14:03:12.090Z",
    "failureReason": "The run could not be started.",
    "agents": [],
    "output": null
  }
}

Returns one run you started with Start a run: its status, the agents working on it, and, once it’s COMPLETED, the report’s id, title, summary, link, and full text.

GET /api/v2/c/{companySlug}/deep-research/{runId}

Read the run until status is COMPLETED or FAILED. Runs take minutes.

Authorization

This endpoint works with any valid API key. You can only read runs started by the member who created the key. A run started by anyone else, or through the Windmill Dashboard, returns 404 Not Found.

Path parameters

string

required

Your company’s slug. Find it in your Dashboard URL, right after /s/:https://app.gowindmill.com/s/{companySlug}/home

string

required

The run’s id, returned as runId by Start a run. Must be a UUID; anything else returns 400.

Query parameters

boolean

Pass true on your first read right after starting a run, so the response includes the run you just created. Leave it off on later reads.

Response

The response wraps the run in a run object.

string

required

The run’s id.

string

required

The run’s status:

RUNNING until the report is finished.
COMPLETED when the report is ready. Terminal. output is set.
FAILED when the run stopped with an error. Terminal. See failureReason. Start a new run to try again.

string

required

The prompt the run was started with.

string

required

ISO 8601 time the run was started.

string

required

ISO 8601 time of the last activity on the run.

string | null

required

ISO 8601 time the run reached COMPLETED or FAILED; null while it’s running.

string | null

required

Why the run failed, in plain language; null unless status is FAILED.

object[]

required

The agents working on the run so far. Empty until research starts, then grows as Windy assigns work.

Show agent properties

string

required

The agent’s name.

string

required

RESEARCHER gathers evidence for one workstream. REPORT_WRITER writes the report.

boolean

required

true once the agent has finished its part of the run.

object | null

required

The finished report. null until status is COMPLETED, and always null when FAILED.

Show output properties

string

required

Always REPORT.

string

required

The report’s id.

number

required

The report’s version. A run always produces version 1.

string

required

The report’s title.

string | null

required

A short summary of the report.

string

required

Where to read the report in the Windmill Dashboard.

string

required

The full report as Markdown, without citations. Open url for the version with its cited sources.

Errors

Status	When
`400 Validation error`	`runId` isn’t a UUID.
`401 Unauthorized`	The API key is missing, malformed, expired, or revoked.
`404 Not Found`	No run with this id exists in your company, or the key’s creator didn’t start it.

The error response body is always shaped like this:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The resource you were looking for could not be found",
    "requestId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d03"
  }
}

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02?fresh=true' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

curl \
  'https://api.gowindmill.com/api/v2/c/acme/deep-research/01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02' \
  -H 'Authorization: Bearer wm_api_xxxxxxxxxxxxxxxxxxxx'

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "RUNNING",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:04:40.118Z",
    "completedAt": null,
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": false }
    ],
    "output": null
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "COMPLETED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:09:52.771Z",
    "completedAt": "2026-09-22T14:09:52.771Z",
    "failureReason": null,
    "agents": [
      { "name": "Delivery pace researcher", "role": "RESEARCHER", "done": true },
      { "name": "Blockers researcher", "role": "RESEARCHER", "done": true },
      { "name": "Report writer", "role": "REPORT_WRITER", "done": true }
    ],
    "output": {
      "type": "REPORT",
      "reportId": "cm3kb1q7e0004l8f0z2r4m8na",
      "reportVersion": 1,
      "title": "Platform team delivery pace, June through August 2026",
      "summary": "Throughput held steady through July, then slowed in August as two large migrations absorbed the team.",
      "url": "https://app.gowindmill.com/s/acme/reports/cm3kb1q7e0004l8f0z2r4m8na/report?v=1",
      "content": "# Platform team delivery pace, June through August 2026\n\nThroughput held steady through July, then slowed in August as two large migrations absorbed the team..."
    }
  }
}

{
  "run": {
    "runId": "01a0d2f4-3b1e-7c8a-9f21-4e6b7a8c9d02",
    "status": "FAILED",
    "prompt": "How did the platform team's delivery pace change over the summer, and what drove it?",
    "createdAt": "2026-09-22T14:03:11.402Z",
    "updatedAt": "2026-09-22T14:03:12.090Z",
    "completedAt": "2026-09-22T14:03:12.090Z",
    "failureReason": "The run could not be started.",
    "agents": [],
    "output": null
  }
}

Getting started

Windy

Org Chart

Review Cycles

Pulse surveys

Feedback

Features

Company settings

Account & admin

Developers

Data

Security and Compliance

Authorization

Path parameters

Query parameters

Response

Errors

​Authorization

​Path parameters

​Query parameters

​Response

​Errors

Authorization

Path parameters

Query parameters

Response

Errors