https://github.com/render-oss/sdk
The official Render SDK
https://github.com/render-oss/sdk
Last synced: about 2 months ago
JSON representation
The official Render SDK
- Host: GitHub
- URL: https://github.com/render-oss/sdk
- Owner: render-oss
- Created: 2025-09-30T17:11:37.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-04-01T15:36:44.000Z (about 2 months ago)
- Last Synced: 2026-04-01T20:56:16.721Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 1.58 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sdk
The official SDK for Render
> [!WARNING]
> **Early Access:** This SDK is in early access and subject to breaking changes without notice.
SDK support is provided for the following languages
Language | README | Package
-----------|----------------------------------------|-----------------
TypeScript | [./typescript](./typescript/README.md) | `@renderinc/sdk`
Python | [./python](./python/README.md) | `render_sdk`
With the following features
Feature | Python | TypeScript
---------------|-----------------|----------------
REST API | ✔️ | ✔️
Workflows | [⚠️ Early Access client](./python/render_sdk/client/workflows.py) | [⚠️ Early Access client](./typescript/src/workflows/client/client.ts)
Object Storage | [⚠️ Early Access client](./python/render_sdk/experimental/object/client.py) | [⚠️ Early Access client](./typescript/src/experimental/object/client.ts)
# Quickstart
To get started you'll need a couple things:
- [A Render API Key](https://render.com/docs/api#1-create-an-api-key)
- The SDK for your language
## Python
To start, get the latest SDK from pypi
```bash
pip install render_sdk
# or
uv add render_sdk
# or
poetry add render_sdk
```
Then initialize a SDK client with your API key
```python
from render import Render
render = Render(token="rnd_...")
```
You may also provide a `RENDER_API_KEY` environment variable instead of providing the key to the constructor.
For more detail see the [Python SDK README](./python/README.md)
## TypeScript
To start get the latest SDK from npm
```bash
npm i @renderinc/sdk
# or
pnpm add @renderinc/sdk
# or
yarn add @renderinc/sdk
# or
bun add @renderinc/sdk
```
Then initialize a SDK client with your API key
```typescript
import { Render } from "@renderinc/sdk";
const render = new Render({token: "rnd_..."})
```
You may also provide a `RENDER_API_KEY` environment variable instead of providing the key to the constructor.
For more detail see the [TypeScript SDK README](./typescript/README.md)
# Contributing
## Development
### Folder structure
```
.
├── python/
│ ├── example
│ └── render_sdk
├── typescript/
│ ├── examples
│ └── src
├── openapi/
│ └── openapi.yaml # Local API Schema for Workflows
└── go/
├── example
└── pkg
```
### Setup
For Python we support a minimum of `3.10`, and use [uv](https://docs.astral.sh/uv/) to manage our dependencies - [see more in our pyproject.toml](https://github.com/renderinc/sdk/blob/main/python/pyproject.toml)
For TypeScript we support a minimum node version of `18.0.0` and use `npm` to manage our dependecies - [see more in our package.json](https://github.com/renderinc/sdk/blob/main/typescript/package.json)
To install pre-commit hooks, run:
```bash
pre-commit install
pre-commit autoupdate
```
### API Documentation
To view workflow API documentation from the OpenAPI spec:
```bash
npx @redocly/cli preview-docs openapi/openapi.yaml
```