Skip to content

SDKs overview

Open-source TypeScript and Python clients for the REST API, generated from its OpenAPI document. Which to pick, how to install, and what a key can do.

guide~2 minVerified v0.178.0

The SDKs are thin clients for the REST API, for developers writing their own code. Both are generated from the API's OpenAPI document, so they cover every endpoint, and both are open source under the MIT licence.

Which one to use

You areUse
Working through an agent such as Claude or CursorMCP tools, at superartifacts.app/mcp
Writing TypeScript or JavaScript on a serverThe TypeScript SDK
Writing PythonThe Python SDK
Writing any other language, or generating your own clientThe REST API

Every MCP tool has an endpoint, and every endpoint has an SDK method. An SDK adds typed calls, errors you can catch, retries that cannot publish twice, iterators over paged reads, and the round trip for uploading files.

Install

bash
npm install @superartifacts/sdk
bash
pip install superartifacts

The TypeScript SDK has no runtime dependencies. Node 20.3+. It uses only the standard fetch, so other runtimes that provide it may work; only Node is tested. The Python SDK needs Python 3.10 or newer.

The key

Create a key in Settings → API keys and put it in the SUPERARTIFACTS_API_KEY environment variable, which both SDKs read. A key can read, or read and write; a read key that calls a write gets a scope_required error.

Server side only

The API refuses any request carrying an Origin header, which every browser adds, and a key on a page is a leaked key. Call the SDKs from a server, a script or a scheduled job.

Source and packages