List tags.

List all existing tags.

get/tags

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/tags/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

linked_onlyboolean

When true, returns only tags associated with at least one document.

user_scopeboolean

When true, scopes results to the current user's accessible document tags and user-created tags. Combined with linked_only, excludes unlinked user-created tags.

Response

Successful operation

idstring required

namestring required

descriptionstring

formatstring

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "name": "marvel",
    "description": "Stories based on Marvel's comics."
  }
]

Changes

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