---
title: "Call video_unit.ship_status"
method: POST
path: "/api/v1/tools/video_unit.ship_status"
tags: ["video_unit"]
---

# Call video_unit.ship_status

`POST /api/v1/tools/video_unit.ship_status`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/video_unit.ship_status`
- Auth: HTTP bearer

Check one video unit's Ship step — 'what's left before this video can go out', 'is this video ready to ship'. Read one video unit's Ship step — which destinations it is going to, and which destination-metadata fields are still unanswered, with the field ids. Use it to tell someone what is left before this video can go out. You cannot ship it: handing off, starting a new version, marking it final and publishing are theirs to do on the Ship screen. Not for choosing the destinations — that is `video_unit.set_destinations`. If they mean the video they are looking at and name no id, CALL IT WITH NO video_unit_id: it resolves the video whose page the question was asked on, and refuses plainly when there is none. Never ask which video, and never say a video is out of reach, before trying that.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `video_unit_id` string, uuid: The video unit, as a UUID. Take it from the conversation's context — never invent one. OMIT it when the person is looking at the video and means that one: the tool resolves the unit whose page the question was asked on, and refuses plainly when there is none. Never ask which video before trying that.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `video_unit_id` string, uuid, required
    - `video_title` string, required
    - `destination_keys` string[], required
    - `no_destination` boolean, required
    - `metadata_requests` object[], required
      - `id` string, required
      - `surface_label` string, required
      - `placement` string, required
      - `field_label` string, required
      - `answered` boolean, required
      - `source` string, nullable, required
    - `more_metadata_requests` boolean, required
    - `metadata_total` integer, required
    - `metadata_written` integer, required
    - `metadata_seeded` integer, required
    - `metadata_edited` integer, required
    - `metadata_unanswered` integer, required
    - `metadata_written_at` string, nullable, required
    - `partial_reads` string[], required
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/0e033701d3f7?raw)