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

# Railway

Railway is a deployment platform for apps and services. Read your projects and deployments and trigger redeploys from your AI workflows.

## Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Railway   | API token      |

### Railway

Connect to Railway to read projects and deployments and trigger redeploys.

#### Set up in Railway

1. Prepare the Railway account or service that the workflow will access. Grant access to the required resources and operations.
2. **API token:** Create an account or workspace token in Account Settings, or a project token in Project Settings. Choose the matching token type below.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Railway**.
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                      | Create an account or workspace token in Account Settings, or a project token in Project Settings. Choose the matching token type below. [Provider instructions](https://railway.com/account/tokens). |
| Token type    | Optional / as applicable | Use account, workspace, or project. Project tokens only access their selected project environment.                                                                                                   |
| Workspace ID  | Optional / as applicable | Required for workspace tokens. With an account token, enter a workspace ID to list that workspace's projects. Leave empty to list personal projects only.                                            |

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

### List Projects

List projects in the connection's workspace. Account tokens without a Workspace ID list personal projects only; project tokens return their selected project.

#### Inputs

| Field       | Type    | Required | Description                                                  |
| ----------- | ------- | -------- | ------------------------------------------------------------ |
| Max results | integer | No       | Max projects to return (1-500). Minimum: 1. Maximum: 500.    |
| Cursor      | string  | No       | Continue from the next cursor returned by the previous call. |

#### Outputs

| Field       | Type        | Description                                                              |
| ----------- | ----------- | ------------------------------------------------------------------------ |
| Next cursor | string      | Pass this cursor to the next call. Null means there are no more results. |
| Projects    | dict\_array | One page of projects within the connection's selected scope.             |
| Count       | integer     | Number of projects returned.                                             |

### Get Project

Fetch a single Railway project by ID.

#### Inputs

| Field      | Type            | Required | Description                                                                          |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Project ID | select (string) | Yes      | The Railway project ID (a UUID) to fetch. Options load from the selected connection. |

#### Outputs

| Field   | Type | Description                    |
| ------- | ---- | ------------------------------ |
| Project | dict | The requested Railway project. |

### List Deployments

List deployments for a Railway project.

#### Inputs

| Field          | Type            | Required | Description                                                                                                  |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| Project ID     | select (string) | Yes      | The Railway project ID (a UUID) to list deployments for. Options load from the selected connection.          |
| Service ID     | select (string) | No       | Optional service ID to filter deployments to one service. Options load from the selected connection.         |
| Environment ID | select (string) | No       | Optional environment ID to filter deployments to one environment. Options load from the selected connection. |
| Max results    | integer         | No       | Max deployments to return (1-500). Minimum: 1. Maximum: 500.                                                 |
| Cursor         | string          | No       | Continue from the next cursor returned by the previous call.                                                 |

#### Outputs

| Field       | Type        | Description                                                              |
| ----------- | ----------- | ------------------------------------------------------------------------ |
| Next cursor | string      | Pass this cursor to the next call. Null means there are no more results. |
| Deployments | dict\_array | Deployments for the project (most recent first).                         |
| Count       | integer     | Number of deployments returned.                                          |

### Get Deployment

Fetch a single Railway deployment by ID.

#### Inputs

| Field         | Type   | Required | Description                                  |
| ------------- | ------ | -------- | -------------------------------------------- |
| Deployment ID | string | Yes      | The Railway deployment ID (a UUID) to fetch. |

#### Outputs

| Field      | Type | Description                       |
| ---------- | ---- | --------------------------------- |
| Deployment | dict | The requested Railway deployment. |

### Redeploy Deployment

Start a new deployment from an existing deployment. This may incur Railway compute charges.

#### Inputs

| Field                  | Type    | Required | Description                                                                       |
| ---------------------- | ------- | -------- | --------------------------------------------------------------------------------- |
| Deployment ID          | string  | Yes      | The Railway deployment ID (a UUID) to redeploy.                                   |
| Use previous image tag | boolean | No       | Reuse the previous image tag instead of the latest (default off). Default: false. |

#### Outputs

| Field         | Type   | Description                                                         |
| ------------- | ------ | ------------------------------------------------------------------- |
| Deployment ID | string | The new deployment ID. Use Get Deployment to check its progress.    |
| Status        | string | The initial status. The deployment may still be queued or building. |

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