StackAI API developer guide

Build applications that run StackAI workflows, search knowledge, invoke connected tools, and measure quality. Start with a working request, then use the reference for exact parameters, request bodies, response schemas, and errors.

Use the public REST reference for workflow execution, knowledge bases, integration actions, evaluations, skills, and webhook subscriptions. Each operation states its route version and request contract. SCIM uses separate provisioning credentials and protocol responses.

Choose your starting point

Your goal	Start here	What you need
Run a workflow from your backend	Quickstart, then Runs v2	Published project, personal API key, input keys
Stream a response to an application	Legacy inference and streaming	Published flow, API key, SSE-capable client
Upload documents and retrieve passages	Knowledge ingestion and search	Knowledge base access and indexing/query permissions
Call an integration action	Providers and connections	Existing connection, action schema, use permission
Regression-test a workflow	Evaluations and monitors	Project contract, dataset, evaluator, experiment
Publish reusable instructions	Skills and versions	Skill authoring permissions, bundle or form fields
Receive signed notifications	Webhooks	Authorized administrator, HTTPS receiver
Provision users and groups	SCIM provisioning	SCIM token and identity-provider configuration

The API version is part of each route. Do not prepend /v2 to a legacy route. The specification's info.version is the document/service version, not a promise that every path has that version. A project version is a third, separate concept: it selects a saved workflow snapshot.