jitprompt Pinned documents API

openapi: 3.2.0
info:
  title: jitprompt Pinned documents API
  version: 0.1.0
  description: 'Manage the documents in a namespace from scripts and CI. Authenticate with the same namespace API key your agents use for MCP: `Authorization: Bearer imcp_...`. The key decides the namespace; every route acts on it alone.


    Guides: https://docs.jitprompt.com'
servers:
- url: https://app.jitprompt.com
tags:
- name: Pinned documents
paths:
  /pins:
    get:
      tags:
      - Pinned documents
      summary: List pinned documents
      description: 'The pinned documents in order, each with its estimated tokens, and the

        block''s total against the namespace''s cap. Every client agent gets the

        pinned documents without asking: in the MCP `instructions`, or at the top

        of its first get_toc or search_instructions response. A document with

        `included: false` is pinned but left out — not ready yet, or past the cap

        since an edit grew it.'
      operationId: listPins
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pins'
      security:
      - HTTPBearer: []
    put:
      tags:
      - Pinned documents
      summary: Set the pinned documents
      description: 'Replace the pinned list with these documents, in this order: ids (full

        or the 8-character prefix the tools show) or file names (`source_name`,

        with or without the extension). An empty list unpins everything. 422 if

        the block would pass the cap.'
      operationId: setPins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinOrder'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pins'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /documents/{document_id}/pin:
    post:
      tags:
      - Pinned documents
      summary: Pin a document
      description: 'Pin one ready document, after those already pinned. 422 if the block

        would pass the cap.'
      operationId: pinDocument
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pins'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Pinned documents
      summary: Unpin a document
      description: Unpin a document. Deleting a document unpins it too.
      operationId: unpinDocument
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pins'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pins/cap:
    put:
      tags:
      - Pinned documents
      summary: Set the pinned-token cap
      description: 'The most estimated tokens the pinned block may take, up to the

        server''s maximum; `null` for the default. 422 below what is pinned now.'
      operationId: setPinCap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinCap'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pins'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PinOrder:
      properties:
        documents:
          items:
            type: string
          type: array
          title: Documents
      type: object
      required:
      - documents
      title: PinOrder
    PinCap:
      properties:
        cap:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cap
      type: object
      title: PinCap
    Pins:
      properties:
        pins:
          items:
            $ref: '#/components/schemas/PinnedDocument'
          type: array
          title: Pins
        total_tokens:
          type: integer
          title: Total Tokens
        cap:
          type: integer
          title: Cap
        max:
          type: integer
          title: Max
      type: object
      required:
      - pins
      - total_tokens
      - cap
      - max
      title: Pins
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PinnedDocument:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        source_name:
          type: string
          title: Source Name
        status:
          type: string
          title: Status
        est_tokens:
          type: integer
          title: Est Tokens
        included:
          type: boolean
          title: Included
      type: object
      required:
      - id
      - title
      - source_name
      - status
      - est_tokens
      - included
      title: PinnedDocument
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      description: A namespace API key (`imcp_...`), created on the namespace's API keys page.