Open Web UI icon

Open Web UI

OpenWebUI

Actions304

Chats → get_pinned_status_by_id_api_v1_chats__id__pinned_get

AI-generated

Summary

Retrieve the pinned status of a specific chat by its unique ID.

Inputs

  • Id (required) — The unique identifier of the chat for which to get the pinned status.
  • Skip Authentication — Optionally skip authentication when making the request; defaults to false (authentication required).

Output shape

A single JSON object indicating the pinned status of the specified chat.

Requires the chat ID as a path parameter. The operation performs an HTTP GET request to the path '/api/v1/chats/{id}/pinned' and returns the pinned status data. An Open WebUI Auth credential is applied by default unless 'Skip Authentication' is enabled.

Examples

Example 1: Getting the pinned status

Specify the chat ID in path parameters to retrieve whether this chat is pinned.

Links

Discussion