PinnedDocument

Type object

Shape

Field	Type	Description
chat_idrequired	ChatId	ChatId - a client-minted UUID v4, never derived from content or location.
document_idrequired	DocumentId	DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
display_titlerequired	string
pinnedrequired	boolean
first_used_atrequired	Timestamp	Epoch milliseconds, UTC. Signed, so instants before 1970 are representable.
last_used_atrequired	Timestamp	Epoch milliseconds, UTC. Signed, so instants before 1970 are representable.

Example

{
  "chat_id": "00000000-0000-4000-8000-000000000000",
  "document_id": "00000000-0000-4000-8000-000000000000",
  "display_title": "string",
  "pinned": false,
  "first_used_at": 0,
  "last_used_at": 0
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated November 12, 2026.