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

# Render

Inspect Render services and deploy history, and trigger deployments from StackAI workflows.

## Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Render    | API Key        |

### Render

Connect to Render with an account API key to inspect services and deploys, and trigger deployments.

#### Set up in Render

1. Prepare the Render account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API key in Render Account Settings.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Render**.
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 Key       | Yes      | Create an API key in Render Account Settings. [Provider instructions](https://dashboard.render.com/u/settings#api-keys). |

### 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 **Render** 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 Services

Find Render services the connected account can access, with a few common filters.

#### Inputs

| Field             | Type            | Required | Description                                                                                                                       |
| ----------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Service names     | array           | No       | Only return services with these exact names.                                                                                      |
| Service type      | select (string) | No       | Only return one kind of Render service. Available values: Static site, Web service, Private service, Background worker, Cron job. |
| Region            | select (string) | No       | Only return services in one Render region. Available values: Frankfurt, Oregon, Ohio, Singapore, Virginia.                        |
| Suspension status | select (string) | No       | Filter for suspended or active services. Available values: Suspended, Active.                                                     |
| Include previews  | boolean         | No       | Include pull-request preview services. Default: true.                                                                             |
| Max services      | integer         | No       | Maximum number of services to return. Minimum: 1. Maximum: 100. Default: 20.                                                      |
| Cursor            | string          | No       | Continue from a previous call's next\_cursor.                                                                                     |

#### Outputs

| Field       | Type          | Description                                                         |
| ----------- | ------------- | ------------------------------------------------------------------- |
| Services    | object\_array | Matching Render service summaries.                                  |
| Next cursor | string        | Pass back as cursor to fetch the next page of services, if present. |

### Get Service

Inspect one Render service and its current configuration summary.

#### Inputs

| Field   | Type            | Required | Description                                                               |
| ------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Service | select (string) | Yes      | The Render service to inspect. Options load from the selected connection. |

#### Outputs

| Field   | Type   | Description                 |
| ------- | ------ | --------------------------- |
| Service | object | The Render service details. |

### List Deploys

Review deployment history for one Render service.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                                                                                 |
| -------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Service        | select (string) | Yes      | The service whose deploy history you want. Options load from the selected connection.                                                                                                                                       |
| Deploy status  | select (string) | No       | Only return deploys in one lifecycle status. Available values: Created, Queued, Build in progress, Update in progress, Live, Deactivated, Build failed, Update failed, Canceled, Pre-deploy in progress, Pre-deploy failed. |
| Created after  | datetime        | No       | Only include deploys created after this time.                                                                                                                                                                               |
| Created before | datetime        | No       | Only include deploys created before this time.                                                                                                                                                                              |
| Max deploys    | integer         | No       | Maximum number of deploys to return. Minimum: 1. Maximum: 100. Default: 20.                                                                                                                                                 |
| Cursor         | string          | No       | Continue from a previous call's next\_cursor.                                                                                                                                                                               |

#### Outputs

| Field       | Type          | Description                                                        |
| ----------- | ------------- | ------------------------------------------------------------------ |
| Deploys     | object\_array | Matching Render deploy summaries.                                  |
| Next cursor | string        | Pass back as cursor to fetch the next page of deploys, if present. |

### Get Deploy

Inspect one deploy for a selected Render service.

#### Inputs

| Field   | Type            | Required | Description                                                                         |
| ------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Service | select (string) | Yes      | The Render service that owns the deploy. Options load from the selected connection. |
| Deploy  | select (string) | Yes      | The deploy to inspect. Options load from the selected connection.                   |

#### Outputs

| Field  | Type   | Description                |
| ------ | ------ | -------------------------- |
| Deploy | object | The Render deploy details. |

### Trigger Deploy

Start a deployment for a Render service.

#### Inputs

| Field       | Type            | Required | Description                                                                                                                               |
| ----------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Service     | select (string) | Yes      | The Render service to deploy. Options load from the selected connection.                                                                  |
| Deploy mode | select (string) | No       | Optionally reuse the last successful build instead of running a normal build and deploy. Available values: Build and deploy, Deploy only. |
| Build cache | select (string) | No       | Choose whether to clear the build cache first. Available values: Clear, Do not clear.                                                     |
| Git commit  | string          | No       | Deploy a specific Git commit instead of the latest one.                                                                                   |
| Image URL   | string          | No       | Deploy a specific matching image for an image-backed service.                                                                             |

#### Outputs

| Field  | Type    | Description                                            |
| ------ | ------- | ------------------------------------------------------ |
| Deploy | object  | The created deploy when Render returns it immediately. |
| Queued | boolean | Whether Render accepted the deploy request.            |

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