---
title: "Read a Hive operation found by list_workspace_operations. Uses the connected person and workspace, with the same permissions as Hive. Large results and downloads create temporary private files. Each operation also needs its own granted read scope. Requires an OAuth connection."
method: POST
path: "/api/v1/tools/read_workspace_operation"
---

# Read a Hive operation found by list_workspace_operations. Uses the connected person and workspace, with the same permissions as Hive. Large results and downloads create temporary private files. Each operation also needs its own granted read scope. Requires an OAuth connection.

`POST /api/v1/tools/read_workspace_operation`

## Request

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

## Request body

- object
  - `operation` string, required: An exact operation id returned by list_workspace_operations.
  - `path` object: The named record ids required by this operation.
  - `query` object: Only the query fields listed for this operation.
  - `body` object: Only the editable fields listed for this operation. Hive checks the same rules as its screen.
  - `file` object: An attached file for an operation explicitly advertising file inspection. Other read operations reject files.
    - `download_url` string, required
    - `file_id` string, required
    - `mime_type` string
    - `file_name` string

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