> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/actions/workflow-concepts/workflow-steps/flow/error-step.md).

# Error

Throw custom error messages that terminate the workflow

## What is the Error Step?

The Error Step allows you to terminate the workflow and display a custom error message and error code to users.

The error is composed of two parts:

1. **Error Code:** A custom identifier for the error, which can be used for tracking and debugging in the workflow API
2. **Error Message:** A custom message displayed in the AirOps UI, describing the error with instructions on how to resolve it.

### Example use case

Let's consider a scenario where we want to ensure that user input does not contain any sensitive content. We can configure the Error Step to throw the following error:

1. **Error Code:** `SENSITIVE_CONTENT_ERROR`
2. **Error Message:** `Your input contains sensitive information. Please remove any confidential data before proceeding.`

#### Error Step configuration:

<div data-full-width="false"><figure><img src="https://3762890407-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-bdb8cacb9f40a08ec0b7cf4601ae439d6bd8be63%2FScreenshot%202024-04-26%20at%2013.56.13.png?alt=media" alt="" width="563"><figcaption><p>Error Configuration</p></figcaption></figure></div>

**Error Step displayed to user:**

<figure><img src="https://3762890407-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-39309ca4a0c2116f34bacd477f71323af0e25b6f%2FScreenshot%202024-04-26%20at%2013.57.41.png?alt=media" alt="" width="473"><figcaption><p>Error Message</p></figcaption></figure>


---

# 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.airops.com/actions/workflow-concepts/workflow-steps/flow/error-step.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.
