BidAuthorBidAuthor
Get Started
API reference

Categories

5 endpoints under /v1/categories.

List Categories

get/v1/categories

List categories visible to the current workspace. Each row carries document_count, scoped to the same tenant as the documents pane.

Query parameters

  • include_sharedbooleanoptional

    Include org-wide shared categories

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Category

post/v1/categories

Create a category in the caller's workspace, or org-wide. make_global=True forces workspace_id=NULL.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • namestringrequired
  • descriptionstringoptional
  • applies_toenumoptional

    Role-affinity: 'kb' tags only knowledge-base documents, 'guideline' tags only guideline documents, 'any' tags either.

    kbguidelineany
  • is_metabooleanoptional

    When True the RFP wizard surfaces this category as a bulk-toggle chip above its matching-kind doc grid.

Failures return the error envelope; branch on error_code.

Request
Response

Get Category

get/v1/categories/{category_id}

Get category details and a document count.

Path parameters

  • category_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Category

put/v1/categories/{category_id}

Update a category's name, description, applies_to or is_meta.

Path parameters

  • category_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • namestringoptional
  • descriptionstringoptional
  • applies_toenumoptional
    kbguidelineany
  • is_metabooleanoptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Category

delete/v1/categories/{category_id}

Delete a category. Documents stay; their tag is removed.

Path parameters

  • category_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response