---
title: "Return the whole saved document for one Hive automation, plus a plain sentence for what starts it and for each step, the ids needed to save a change, and everything that would stop it going live."
method: POST
path: "/api/v1/tools/read_flow_document"
---

# Return the whole saved document for one Hive automation, plus a plain sentence for what starts it and for each step, the ids needed to save a change, and everything that would stop it going live.

`POST /api/v1/tools/read_flow_document`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/read_flow_document`
- Auth: HTTP bearer

## Request body

- object
  - `flowId` string, required: The Hive automation to read.

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hivepublish/apis/hive-developer-api.md) · [All operations](https://skmtc.dev/hivepublish/apis/hive-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hivepublish/apis/hive-developer-api/revisions/b440c763583e?raw)