> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/dbt-cloud.md).

# dbt Cloud

dbt Cloud analytics engineering platform. Trigger and monitor dbt job runs, list jobs and runs, and download run artifacts.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector             | Authentication |
| --------------------- | -------------- |
| dbt Cloud (API Token) | API Token      |

#### dbt Cloud (API Token)

Connect to dbt Cloud with an API token. Trigger and monitor dbt job runs, list jobs and runs, and download run artifacts.

**Set up in dbt Cloud**

1. Prepare the dbt Cloud account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** A dbt Cloud personal access token or service account token. Create one in Account Settings > API tokens (or Personal tokens).
3. **Account ID:** Your dbt Cloud account ID (a number). Find it in your dbt Cloud URL, e.g. cloud.getdbt.com/deploy/12345 -> 12345.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **dbt Cloud (API Token)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                |
| ------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Token     | Yes                      | A dbt Cloud personal access token or service account token. Create one in Account Settings > API tokens (or Personal tokens). [Provider instructions](https://docs.getdbt.com/docs/dbt-apis/authentication). |
| Account ID    | Yes                      | Your dbt Cloud account ID (a number). Find it in your dbt Cloud URL, e.g. cloud.getdbt.com/deploy/12345 -> 12345.                                                                                            |
| Access URL    | Optional / as applicable | dbt Cloud region/access URL. Leave the default for US multi-tenant. Use <https://emea.dbt.com>, <https://au.dbt.com>, your cell URL (https\://{prefix}.us1.dbt.com), or your single-tenant access URL.       |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **dbt Cloud** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Trigger Job Run

Trigger a run for a dbt Cloud job.

**Inputs**

| Field           | Type            | Required | Description                                                                        |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------- |
| Job             | select (string) | Yes      | The dbt Cloud job to run. Options load from the selected connection.               |
| Cause           | string          | No       | A short description of why the run was triggered. Default: Triggered via Stack AI. |
| Git Branch      | string          | No       | Optional git branch to check out before running.                                   |
| Git SHA         | string          | No       | Optional git commit SHA to check out before running.                               |
| Schema Override | string          | No       | Optional destination schema to use instead of the configured target.               |
| Steps Override  | array           | No       | Optional list of dbt commands to run instead of the job's steps.                   |

**Outputs**

| Field       | Type    | Description                                                                   |
| ----------- | ------- | ----------------------------------------------------------------------------- |
| Run ID      | integer | The triggered run's ID.                                                       |
| Status Code | integer | Numeric run status (1 Queued, 3 Running, 10 Success, 20 Error, 30 Cancelled). |
| Status      | string  | Human-readable run status.                                                    |
| Run URL     | string  | Deep link to the run in dbt Cloud (empty if unavailable).                     |

#### Run Job and Wait

Trigger a dbt Cloud job and wait for it to finish.

**Inputs**

| Field                   | Type            | Required | Description                                                                                    |
| ----------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Job                     | select (string) | Yes      | The dbt Cloud job to run and wait for. Options load from the selected connection.              |
| Cause                   | string          | No       | A short description of why the run was triggered. Default: Triggered via Stack AI.             |
| Timeout (seconds)       | integer         | No       | Max seconds to wait for the run to finish (max 3600). Minimum: 5. Maximum: 3600. Default: 300. |
| Poll Interval (seconds) | integer         | No       | Seconds between status checks. Minimum: 5. Maximum: 300. Default: 10.                          |

**Outputs**

| Field        | Type    | Description                                                            |
| ------------ | ------- | ---------------------------------------------------------------------- |
| Run ID       | integer | The run's ID.                                                          |
| Status Code  | integer | Numeric run status (10 Success, 20 Error, 30 Cancelled when complete). |
| Status       | string  | Human-readable run status.                                             |
| Succeeded    | boolean | True if the run finished successfully.                                 |
| Errored      | boolean | True if the run finished with an error.                                |
| Cancelled    | boolean | True if the run was cancelled.                                         |
| Timed Out    | boolean | True if the wait deadline passed before the run finished.              |
| Run Duration | string  | How long the run took (empty if not finished).                         |
| Run URL      | string  | Deep link to the run in dbt Cloud (empty if unavailable).              |

#### List Runs

List dbt Cloud runs, optionally filtered by job, project, or status.

**Inputs**

| Field    | Type             | Required | Description                                                                                               |
| -------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| Job      | select (string)  | No       | Optional job to filter runs by. Options load from the selected connection.                                |
| Project  | select (string)  | No       | Optional project to filter runs by. Options load from the selected connection.                            |
| Status   | select (integer) | No       | Optional run status to filter by. Available values: Queued, Starting, Running, Success, Error, Cancelled. |
| Order By | string           | No       | Field to order by; prefix with '-' to reverse (e.g. '-id'). Default: -id.                                 |
| Limit    | integer          | No       | Max runs to return (max 1000). Minimum: 1. Maximum: 1000. Default: 100.                                   |
| Offset   | integer          | No       | Number of runs to skip; pass the previous Next Offset to continue. Minimum: 0. Default: 0.                |

**Outputs**

| Field       | Type        | Description                                                         |
| ----------- | ----------- | ------------------------------------------------------------------- |
| Runs        | dict\_array | The runs on this page (may be capped; see has\_more).               |
| Count       | integer     | Number of runs returned (not necessarily the account total).        |
| Has More    | boolean     | True if more runs exist beyond the returned set.                    |
| Next Offset | integer     | Pass this back as Offset to get the next runs; empty when complete. |

#### Get Run Status

Get the status of a dbt Cloud run.

**Inputs**

| Field           | Type    | Required | Description                                                       |
| --------------- | ------- | -------- | ----------------------------------------------------------------- |
| Run ID          | integer | Yes      | The run to check.                                                 |
| Include Related | string  | No       | Optional comma-separated related objects (e.g. 'run\_steps,job'). |

**Outputs**

| Field          | Type    | Description                                               |
| -------------- | ------- | --------------------------------------------------------- |
| Run ID         | integer | The run's ID.                                             |
| Status Code    | integer | Numeric run status.                                       |
| Status         | string  | Human-readable run status.                                |
| Status Message | string  | Provider status message (empty if none).                  |
| Complete       | boolean | True if the run has reached a terminal state.             |
| Succeeded      | boolean | True if the run finished successfully.                    |
| Errored        | boolean | True if the run finished with an error.                   |
| Run URL        | string  | Deep link to the run in dbt Cloud (empty if unavailable). |

#### List Jobs

List dbt Cloud jobs, optionally filtered by project or name.

**Inputs**

| Field         | Type            | Required | Description                                                                                |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------------------------ |
| Project       | select (string) | No       | Optional project to filter jobs by. Options load from the selected connection.             |
| Name Contains | string          | No       | Optional case-insensitive substring to filter job names.                                   |
| Limit         | integer         | No       | Max jobs to return (max 1000). Minimum: 1. Maximum: 1000. Default: 100.                    |
| Offset        | integer         | No       | Number of jobs to skip; pass the previous Next Offset to continue. Minimum: 0. Default: 0. |

**Outputs**

| Field       | Type        | Description                                                         |
| ----------- | ----------- | ------------------------------------------------------------------- |
| Jobs        | dict\_array | The jobs on this page (may be capped; see has\_more).               |
| Count       | integer     | Number of jobs returned (not necessarily the account total).        |
| Has More    | boolean     | True if more jobs exist beyond the returned set.                    |
| Next Offset | integer     | Pass this back as Offset to get the next jobs; empty when complete. |

#### List Run Artifacts

List the artifact files generated by a dbt Cloud run.

**Inputs**

| Field  | Type    | Required | Description                                |
| ------ | ------- | -------- | ------------------------------------------ |
| Run ID | integer | Yes      | The completed run whose artifacts to list. |

**Outputs**

| Field     | Type          | Description                               |
| --------- | ------------- | ----------------------------------------- |
| Artifacts | string\_array | Artifact file paths generated by the run. |
| Count     | integer       | Number of artifact paths returned.        |

#### Get Run Artifact

Download an artifact file (e.g. manifest.json) from a dbt Cloud run.

**Inputs**

| Field    | Type            | Required | Description                                                                                   |
| -------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Run ID   | integer         | Yes      | The completed run to fetch the artifact from.                                                 |
| Artifact | select (string) | Yes      | Which artifact to download. Available values: manifest.json, run\_results.json, catalog.json. |
| Step     | integer         | No       | Optional 1-indexed run step; defaults to the last step. Minimum: 1.                           |

**Outputs**

| Field         | Type   | Description                                                    |
| ------------- | ------ | -------------------------------------------------------------- |
| Artifact Path | string | The artifact path that was fetched.                            |
| Content       | object | The parsed artifact content (JSON for the standard artifacts). |

#### Cancel Run

Cancel an in-progress dbt Cloud run.

**Inputs**

| Field  | Type    | Required | Description                    |
| ------ | ------- | -------- | ------------------------------ |
| Run ID | integer | Yes      | The in-progress run to cancel. |

**Outputs**

| Field       | Type    | Description                                   |
| ----------- | ------- | --------------------------------------------- |
| Run ID      | integer | The cancelled run's ID.                       |
| Status Code | integer | Numeric run status after cancellation.        |
| Status      | string  | Human-readable run status after cancellation. |
| Cancelled   | boolean | True if the run is cancelled.                 |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/dbt-cloud.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
