> For the complete documentation index, see [llms.txt](https://taskflow-1.gitbook.io/taskflow-docs-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://taskflow-1.gitbook.io/taskflow-docs-1/readme.md).

# Overview

[![docs-ci](https://github.com/cynthiawang109-sudo/taskflow-api-docs/actions/workflows/docs-ci.yml/badge.svg)](https://github.com/cynthiawang109-sudo/taskflow-api-docs/actions/workflows/docs-ci.yml) API contracts for **TaskFlow** (fictional SaaS): the conventions every TaskFlow service follows, and the data model behind them. If code disagrees with this repo, that is a finding — raise it, don't silently pick a side.

Part of [ai-workspace-kit](https://github.com/cynthiawang109-sudo/ai-workspace-kit). System-level docs live in the sibling repo `taskflow-docs`.

## Contents

| File                 | What it covers                                                                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `api-conventions.md` | Versioning, errors, pagination, health-check contract                                                                                 |
| `data-model.md`      | Core tables and their invariants                                                                                                      |
| `endpoints.md`       | The production endpoint reference, with demo coverage marked                                                                          |
| `errors.md`          | The error code catalog and how to choose a code                                                                                       |
| `webhooks.md`        | Events, payloads, signing, delivery semantics                                                                                         |
| `rate-limiting.md`   | Limits per credential class, 429 behavior, exemptions                                                                                 |
| `openapi.yaml`       | The demo implementation's OpenAPI spec (generated from demo-app, then curated); published to GitBook as the interactive API reference |


---

# 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://taskflow-1.gitbook.io/taskflow-docs-1/readme.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.
