Introducing REST API
June 21, 2025
Use the REST API to manage your assistants.
You asked, we listened. Many teams build on Superinterface using a variety of languages and frameworks. Until now, most integrations relied on our React SDK, a simple script tag, or an iframe. Today we’re excited to open things up with a full REST API, giving you the flexibility to control your workspace from any environment.
Why a REST API?
Direct HTTP access lets you call Superinterface from anywhere—shell scripts, Python code, or even serverless functions that can’t easily load browser-based libraries. The REST API mirrors the features of our client-side integrations, so you can mix and match without losing capabilities.
Core capabilities
Assistants – create, update, list or delete assistants
Initial messages – define greetings shown in new threads
Messages – post and read thread messages
AI providers – configure OpenAI, Anthropic and more
API keys – generate and rotate public keys
Public vs private keys
Alongside the REST API, we’re rolling out private API keys. Public keys remain safe for client-side use and offer limited access. Private keys provide full control over your workspace via REST and should only be used in secure server environments.
Every endpoint uses standard JSON payloads and straightforward URL patterns. Authentication works the same way as the rest of Superinterface: send your private API key in the
Authorization header.Designed for flexibility
Whether you’re scripting quick automations with
curl or wiring Superinterface into a large production system, the REST API adapts to your workflow. Responses include the same data shapes returned by our client libraries, so switching between the two is seamless.Example
curl -X GET "https://superinterface.ai/api/cloud/assistants" \
-H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \
-H "Content-Type: application/json"
The response is a list of assistants in your workspace—ideal for dashboards or migration scripts.
Get started
Read the REST API documentation for a complete list of endpoints, request examples, and error codes.