Skip to content

API Reference

Integrate Sire into your applications using the REST API.

Base URL: https://api.sire.run

All requests require a Bearer token in the Authorization header, except auth endpoints.

Authentication

POST/api/v1/auth/signupCreate a new account
POST/api/v1/auth/loginLog in and receive access token
POST/api/v1/auth/refreshRefresh access token

Workflows

GET/api/v1/workflowsList workflows (supports ?include=stats)
POST/api/v1/workflowsCreate a new workflow
GET/api/v1/workflows/:idGet workflow by ID
DELETE/api/v1/workflows/:idDelete a workflow

Executions

POST/api/v1/workflows/:id/executeExecute a workflow
GET/api/v1/executionsList executions
GET/api/v1/executions/:idGet execution details

Billing & Usage

GET/api/v1/usage/cuGet CU rate list
GET/api/v1/billing/currentGet current billing period

API Keys

GET/api/v1/apikeysList API keys
POST/api/v1/apikeysCreate an API key
DELETE/api/v1/apikeys/:idRevoke an API key

Chat SDK

Embed a Sire chat widget in your application using the @sire/chat package.

npm install @sire/chat

React: Use <SireChat config={...} /> or wrap with <SireChatProvider>

Vanilla JS: Use mount(config) and unmount()

View full SDK documentation →