> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/stackai-api/stackai-api-developer-guide.md).

# 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/stackai-api/stackai-api-developer-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.