> 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/upstash.md).

# Upstash

Manage serverless Redis databases and deliver messages with QStash.

## Connectors

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

| Connector                        | Authentication   |
| -------------------------------- | ---------------- |
| Upstash Developer API and QStash | API key or token |

### Upstash Developer API and QStash

Manage Redis databases and publish through QStash.

#### Set up in Upstash

1. Prepare the Upstash account or service that the workflow will access. Grant access to the required resources and operations.
2. **Developer API Key:** Create a named key under Account > Management API and copy it immediately.
3. **QStash Region:** Region selected in the QStash Console when copying QSTASH\_TOKEN.
4. **QStash Token:** Copy QSTASH\_TOKEN from QStash Quickstart in the selected region.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Upstash Developer API and QStash**.
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                                                                                                                                                        |
| --------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Upstash Account Email | Yes                      | Email for a native Upstash account. Third-party marketplace accounts cannot use the Developer API. [Provider instructions](https://console.upstash.com/account/api). |
| Developer API Key     | Yes                      | Create a named key under Account > Management API and copy it immediately. [Provider instructions](https://console.upstash.com/account/api).                         |
| QStash Region         | Optional / as applicable | Region selected in the QStash Console when copying QSTASH\_TOKEN.                                                                                                    |
| QStash Token          | Yes                      | Copy QSTASH\_TOKEN from QStash Quickstart in the selected region. [Provider instructions](https://console.upstash.com/qstash).                                       |

### 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 **Upstash** 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

### Create Redis Database

Create a persistent Upstash Redis database.

#### Inputs

| Field                     | Type                      | Required | Description                                                                                                                                                                                                                                                                                                |
| ------------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Database Name             | string                    | Yes      | Unique name for the Redis database.                                                                                                                                                                                                                                                                        |
| Cloud Platform            | select (string)           | Yes      | Cloud platform that hosts the database. Available values: AWS, Google Cloud.                                                                                                                                                                                                                               |
| Primary Region            | select (string)           | Yes      | Primary deployment region. Available values: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, ap-south-1, ap-northeast-1, ap-southeast-1, ap-southeast-2, af-south-1, us-central1, us-east4, europe-west1, asia-northeast1.                        |
| Read Regions              | multiple\_select (string) | No       | Optional regions for read replicas. Available values: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, ap-south-1, ap-northeast-1, ap-southeast-1, ap-southeast-2, af-south-1, us-central1, us-east4, europe-west1, asia-northeast1. Default: \[]. |
| Plan                      | select (string)           | Yes      | Billing plan for the database. Available values: Free, Payg, Fixed 250Mb, Fixed 1Gb, Fixed 5Gb, Fixed 10Gb, Fixed 50Gb, Fixed 100Gb, Fixed 500Gb.                                                                                                                                                          |
| Monthly Budget            | integer                   | No       | Optional pay-as-you-go budget.                                                                                                                                                                                                                                                                             |
| Require TLS               | boolean                   | No       | Require encrypted database connections. Default: true.                                                                                                                                                                                                                                                     |
| Enable Eviction           | boolean                   | No       | Allow Redis to evict keys at the memory limit. Default: false.                                                                                                                                                                                                                                             |
| Confirm Database Creation | boolean                   | Yes      | Confirm creation of a persistent, potentially billable database.                                                                                                                                                                                                                                           |

#### Outputs

| Field    | Type   | Description                                      |
| -------- | ------ | ------------------------------------------------ |
| Database | object | Created database without connection credentials. |

### List Redis Databases

List Redis databases in the Upstash account.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field     | Type  | Description                     |
| --------- | ----- | ------------------------------- |
| Databases | array | All accessible Redis databases. |

### Get Redis Database Details

Get safe metadata for one Redis database.

#### Inputs

| Field    | Type            | Required | Description                                                           |
| -------- | --------------- | -------- | --------------------------------------------------------------------- |
| Database | select (string) | Yes      | Redis database to inspect. Options load from the selected connection. |

#### Outputs

| Field    | Type   | Description                           |
| -------- | ------ | ------------------------------------- |
| Database | object | Database details without credentials. |

### Publish QStash Message

Publish a raw message through QStash.

#### Inputs

| Field                       | Type            | Required | Description                                                                                           |
| --------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| Destination Type            | select (string) | Yes      | Send to one public URL or a QStash URL Group. Available values: Public URL, URL Group. Default: url.  |
| Destination URL             | string          | Yes      | Public HTTP(S) endpoint that receives the message.                                                    |
| URL Group                   | select (string) | Yes      | QStash URL Group that receives the message. Options load from the selected connection.                |
| Message Body                | textarea        | Yes      | Raw message body delivered without JSON wrapping.                                                     |
| Content Type                | string          | No       | Media type of the raw message. Default: application/json.                                             |
| Delivery Method             | select (string) | No       | HTTP method QStash uses for delivery. Available values: GET, POST, PUT, PATCH, DELETE. Default: POST. |
| Retries                     | integer         | No       | Retry attempts after delivery failures.                                                               |
| Delay                       | string          | No       | Delay before delivery, such as 50s, 5m, 2h, or 1d.                                                    |
| Not Before                  | integer         | No       | Unix timestamp before which QStash must not deliver.                                                  |
| Deduplication ID            | string          | No       | Stable ID that prevents duplicate delivery for 10 minutes.                                            |
| Content-Based Deduplication | boolean         | No       | Deduplicate matching destination, body, content type, and forwarded headers. Default: false.          |
| Confirm Billable Delivery   | boolean         | Yes      | Confirm at-least-once delivery and billable attempts.                                                 |

#### Outputs

| Field    | Type  | Description                                             |
| -------- | ----- | ------------------------------------------------------- |
| Messages | array | Accepted QStash messages, one per destination endpoint. |

### Create or Update QStash URL Group

Create a QStash URL Group or add an endpoint to one.

#### Inputs

| Field                  | Type            | Required | Description                                                                  |
| ---------------------- | --------------- | -------- | ---------------------------------------------------------------------------- |
| URL Group Name         | select (string) | Yes      | New or existing QStash URL Group. Options load from the selected connection. |
| Endpoint URL           | string          | Yes      | Public HTTP(S) endpoint to add.                                              |
| Endpoint Name          | string          | No       | Optional readable endpoint name.                                             |
| Confirm Routing Change | boolean         | Yes      | Confirm a persistent URL Group routing change.                               |

#### Outputs

| Field     | Type   | Description                          |
| --------- | ------ | ------------------------------------ |
| URL Group | object | URL Group after the endpoint upsert. |

## 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/upstash.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.
