---
title: "Pin a document"
method: POST
path: "/documents/{document_id}/pin"
tags: ["Pinned documents"]
---

# Pin a document

`POST /documents/{document_id}/pin`

## Request

- Base URL: `https://app.jitprompt.com`
- URL: `https://app.jitprompt.com/documents/{document_id}/pin`
- Auth: HTTP bearer

Pin one ready document, after those already pinned. 422 if the block
would pass the cap.

## Path parameters

- `document_id` string, required

## Response `200`

Successful Response

- Pins
  - `pins` PinnedDocument[], required
    - `id` string, required
    - `title` string, required
    - `source_name` string, required
    - `status` string, required
    - `est_tokens` integer, required
    - `included` boolean, required
  - `total_tokens` integer, required
  - `cap` integer, required
  - `max` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/jitprompt/apis/jitprompt-api.md) · [All operations](https://skmtc.dev/jitprompt/apis/jitprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jitprompt/apis/jitprompt-api/revisions/394bd8fb9f92?raw)