Agent Guidance

Create or update guidance for a workspace or project (upsert)

projectId is required when scope is "project" and must be omitted when scope is "workspace" — a mismatch is a 400.

put/api/workspaces/{workspaceId}/guidance

Request

  • Base URL: https://hiveship.app/api
  • URL: https://hiveship.app/api/api/workspaces/{workspaceId}/guidance
  • Auth: API key in cookie hiveship_access

Path parameters

workspaceIdstring required

Request body

contentstring required
scope'workspace' | 'project'
projectIdstring cuid

Response

Guidance created or updated

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.