PIpirros
Stashes

Create a stash

Create a workspace-scoped stash. Accepts an optional Idempotency-Key header for safe retries. The candidate stash must satisfy a granted stash:write filter (403 invalid_filter otherwise); an invalid item reference returns 400 INVALID_ITEM_REFERENCE. The response equals a subsequent GET. Ownership: a stash created with an API key is owned by the member who created the key, and one created through a connected AI client by the member who connected it. By default it appears in that member's Private stash list. An API key whose stash placement a firm administrator set to "firm" creates a firm stash instead, listed under Firm for every member whose role can view firm stashes; while the key's creator lacks the Create Firm Stashes permission in the workspace the request is refused with 403 FIRM_STASH_NOT_PERMITTED, and no private stash is made in its place. is_firm_stash in the response says which it is.

post/v1/workspaces/{workspaceId}/stashes

Request

  • Base URL
    https://external-api.pirros.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.pirros.com/oauth/token

Path parameters

workspaceIdstring uuid required

Request body

namestring required
descriptionstring nullable
project_idstring uuid required
is_permanentboolean

Response

Stash created

Example response

{
  "response": {
    "id": "8a3b1c4d-22de-4f9a-9e3a-77b88ad0e514",
    "name": "Wall Sections - North Wing",
    "description": "Curated wall sections for the schematic-design package",
    "project_id": "9f5b3c2d-1ea8-4f2c-8a61-d1c9e54b03f1",
    "firm_id": "f1a8e3d2-9c4b-4f7e-8a6d-1c3b5e7d9a02",
    "workspace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "is_permanent": true,
    "is_firm_stash": false,
    "is_archived": false,
    "downloaded_at": "2026-02-01T14:22:00Z",
    "items": [
      {
        "item_type": "detail",
        "detail_id": "b3a8f1c4-22de-4f9a-9e3a-77b88ad0e514",
        "family_id": null
      },
      {
        "item_type": "family",
        "detail_id": null,
        "family_id": "c4b9f2d5-33ef-450b-af4b-88c99be1f625"
      }
    ],
    "created_at": "2026-01-15T10:30:00Z"
  }
}

Changes

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