LOOMA / ДОКУМЕНТАЦИЯ

API приложения

Справочник сгенерирован из OpenAPI текущего кода. Не выполняет запросы. Авторизация и примеры · Скачать OpenAPI JSON ↓

Найти endpoint

POST/api/conversion/pausePause

Pause

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/conversion/resumeResume

Resume

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/conversion/statusStatus

Status

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/conversion/{pdf_id}/retryRetry

Retry

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/duplicatesList Duplicates

List Duplicates

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/DuplicatePairSchema"
          },
          "title": "Response List Duplicates Api Duplicates Get",
          "type": "array"
        }
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/duplicates/countGet Duplicate Count

Get Duplicate Count

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/duplicates/{dup_id}/resolveResolve Duplicate

action: "replace_old" | "keep_old" | "keep_both" replace_old: delete the existing (old) PDF, keep new keep_old: delete the new PDF, keep existing keep_both: just dismiss the duplicate record

Параметр	Где	Обязателен	Описание / схема
`dup_id`	path	Да	{ "title": "Dup Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ResolveDuplicateRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/favoritesList Favorites

List Favorites

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/FavoriteItem"
          },
          "title": "Response List Favorites Api Favorites Get",
          "type": "array"
        }
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/favoritesAdd Favorite

Add Favorite

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AddFavoriteRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/FavoriteItem"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

DELETE/api/favorites/by-page/{pdf_id}/{page_number}Remove Favorite By Page

Remove Favorite By Page

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`page_number`	path	Да	{ "title": "Page Number", "type": "integer" }

Ответы

{
  "204": {
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/favorites/check/{pdf_id}Get Favorited Pages

Return list of page_numbers (0-indexed) that are favourited for a given PDF.

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "type": "integer"
          },
          "title": "Response Get Favorited Pages Api Favorites Check  Pdf Id  Get",
          "type": "array"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

DELETE/api/favorites/{favorite_id}Remove Favorite

Remove Favorite

Параметр	Где	Обязателен	Описание / схема
`favorite_id`	path	Да	{ "title": "Favorite Id", "type": "integer" }

Ответы

{
  "204": {
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/indexing/cancel/{pdf_id}Cancel Job

Cancel Job

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/indexing/pausePause

Pause

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/indexing/resumeResume

Resume

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/indexing/statusGet Status

Get Status

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/IndexingStatusResponse"
        }
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/indexing/streamStream Progress

Server-Sent Events endpoint for real-time indexing progress. Connect with EventSource('/api/indexing/stream').

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/ocr/enginesEngines

Engines

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/ocr/enqueueEnqueue

Enqueue

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EnqueueRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/ocr/indexIndex Stats

Index Stats

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/ocr/index/rebuildRebuild

Rebuild

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/ocr/pages/{pdf_id}/{page_number}Recognize Page Now

Recognize Page Now

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`page_number`	path	Да	{ "title": "Page Number", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/ocr/pausePause

Pause

Параметр	Где	Обязателен	Описание / схема
`kind`	query	Нет	{ "default": "ocr", "enum": [ "ocr", "text" ], "title": "Kind", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/ocr/resumeResume

Resume

Параметр	Где	Обязателен	Описание / схема
`kind`	query	Нет	{ "default": "ocr", "enum": [ "ocr", "text" ], "title": "Kind", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/ocr/statusStatus

Status

Параметр	Где	Обязателен	Описание / схема
`kind`	query	Нет	{ "default": "ocr", "enum": [ "ocr", "text" ], "title": "Kind", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pages/{pdf_id}/fileGet Pdf File

Return the original PDF file for viewing.

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pages/{pdf_id}/findFind Document Text

Find Document Text

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`q`	query	Да	{ "maxLength": 2000, "minLength": 1, "title": "Q", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pages/{pdf_id}/{page_number}/imageGet Page Image

Return the rendered JPEG thumbnail for a specific page.

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`page_number`	path	Да	{ "title": "Page Number", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pages/{pdf_id}/{page_number}/textGet Page Text

Native and OCR text with normalized layout and literal query matches (0-based page).

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`page_number`	path	Да	{ "title": "Page Number", "type": "integer" }
`q`	query	Нет	{ "default": "", "maxLength": 2000, "title": "Q", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfsList Pdfs

List Pdfs

Параметр	Где	Обязателен	Описание / схема
`search`	query	Нет	Filter by filename or tag { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by filename or tag", "title": "Search" }
`tag`	query	Нет	Filter by exact tag name { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact tag name", "title": "Tag" }
`embedder_name`	query	Нет	Compute per-model index status { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Compute per-model index status", "title": "Embedder Name" }
`space_id`	query	Нет	{ "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Space Id" }
`skip`	query	Нет	{ "default": 0, "title": "Skip", "type": "integer" }
`limit`	query	Нет	{ "default": 10000, "title": "Limit", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/PDFListItem"
          },
          "title": "Response List Pdfs Api Pdfs Get",
          "type": "array"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/pdfsUpload Pdf

Upload Pdf

Тело запроса

{
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/Body_upload_pdf_api_pdfs_post"
      }
    }
  },
  "required": true
}

Ответы

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/pdfs/moveMove Pdfs

Move Pdfs

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MoveDocumentsRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

DELETE/api/pdfs/{pdf_id}Delete Pdf

Delete Pdf

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "204": {
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfs/{pdf_id}Get Pdf

Get Pdf

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfs/{pdf_id}/anytype-linkAnytype Link

Anytype Link

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/pdfs/{pdf_id}/auto-tagAuto Tag Pdf

Compute auto-tags for a PDF and apply them. Returns applied tags.

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfs/{pdf_id}/fileDownload Pdf

Download Pdf

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PUT/api/pdfs/{pdf_id}/metadataUpdate Metadata

Update Metadata

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataUpdateRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/pdfs/{pdf_id}/reindexReindex Pdf

Reindex Pdf

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "202": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PUT/api/pdfs/{pdf_id}/renameRename Pdf

Rename Pdf

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/RenameRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/pdfs/{pdf_id}/replaceReplace Document

Replace Document

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Тело запроса

{
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/Body_replace_document_api_pdfs__pdf_id__replace_post"
      }
    }
  },
  "required": true
}

Ответы

{
  "202": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PUT/api/pdfs/{pdf_id}/tagsUpdate Tags

Update Tags

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TagsUpdateRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PDFResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfs/{pdf_id}/versionsDocument Versions

Document Versions

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/pdfs/{pdf_id}/versions/{version}/fileDownload Version

Download Version

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	path	Да	{ "title": "Pdf Id", "type": "integer" }
`version`	path	Да	{ "title": "Version", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/searchSearch Pdfs

Search Pdfs

Параметр	Где	Обязателен	Описание / схема
`q`	query	Да	Search query { "description": "Search query", "minLength": 1, "title": "Q", "type": "string" }
`space_id`	query	Нет	{ "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Space Id" }
`space_ids`	query	Нет	{ "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Space Ids" }
`k`	query	Нет	Max results { "default": 100, "description": "Max results", "maximum": 100, "minimum": 1, "title": "K", "type": "integer" }
`semantic_weight`	query	Нет	0 = BM25 only, 1 = embeddings only { "default": 0.5, "description": "0 = BM25 only, 1 = embeddings only", "maximum": 1, "minimum": 0, "title": "Semantic Weight", "type": "number" }
`include_text`	query	Нет	Include native/OCR text and page layout { "default": false, "description": "Include native/OCR text and page layout", "title": "Include Text", "type": "boolean" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SearchResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/search/heatmapSimilarity Heatmap

Compute and return a per-patch similarity heatmap as a semi-transparent PNG overlay.

Параметр	Где	Обязателен	Описание / схема
`pdf_id`	query	Да	{ "title": "Pdf Id", "type": "integer" }
`page`	query	Да	{ "title": "Page", "type": "integer" }
`q`	query	Да	{ "minLength": 1, "title": "Q", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/search/statusSearch Status

Return whether the search model is loaded and ready.

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

GET/api/search/streamSearch Stream

Request-scoped progress and result; no global progress shared by searches.

Параметр	Где	Обязателен	Описание / схема
`q`	query	Да	{ "minLength": 1, "title": "Q", "type": "string" }
`space_id`	query	Нет	{ "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Space Id" }
`space_ids`	query	Нет	{ "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Space Ids" }
`k`	query	Нет	{ "default": 100, "maximum": 100, "minimum": 1, "title": "K", "type": "integer" }
`semantic_weight`	query	Нет	{ "default": 0.5, "maximum": 1, "minimum": 0, "title": "Semantic Weight", "type": "number" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settingsGet Settings

Get Settings

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SettingsResponse"
        }
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PUT/api/settingsUpdate Settings

Update Settings

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SettingsUpdateRequest"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SettingsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settings/embeddersList Available Embedders

List Available Embedders

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/EmbedderInfo"
          },
          "title": "Response List Available Embedders Api Settings Embedders Get",
          "type": "array"
        }
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/settings/embedders/{name}/downloadDownload Embedder

Start downloading the model for an embedder (background thread).

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

DELETE/api/settings/embedders/{name}/indexDelete Model Index

Delete Model Index

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/settings/embedders/{name}/index-allIndex All For Embedder

Queue all PDFs with rendered pages for indexing with the specified embedder. Accepts both locally registered embedder names and external model names — the worker resolves which actual embedder to use based on current settings.

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settings/embedders/{name}/resourcesEmbedder Resources

Embedder Resources

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settings/embedders/{name}/statusEmbedder Status

Return current download/indexing status for an embedder.

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/EmbedderInfo"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/settings/embedders/{name}/unloadUnload Local Model

Unload Local Model

Параметр	Где	Обязателен	Описание / схема
`name`	path	Да	{ "title": "Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settings/external-embeddersList External Embedders

Proxy: fetch available embedders from the configured external embed server. The ``url`` and ``api_key`` query parameters override values stored in settings so the client can probe a server before saving.

Параметр	Где	Обязателен	Описание / схема
`url`	query	Нет	{ "title": "Url", "type": "string" }
`api_key`	query	Нет	{ "title": "Api Key", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/settings/model-indexing-statsModel Indexing Stats

Model Indexing Stats

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/settings/rebuild-indexRebuild Index Endpoint

Rebuild Index Endpoint

Параметр	Где	Обязателен	Описание / схема
`embedder_name`	query	Нет	{ "title": "Embedder Name", "type": "string" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/spacesList Spaces

List Spaces

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/spacesCreate Space

Create Space

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CreateSpace"
      }
    }
  },
  "required": true
}

Ответы

{
  "201": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/spaces/anytype/catalogRefresh Anytype Catalog

Refresh Anytype Catalog

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PATCH/api/spaces/anytype/selectionSet Anytype Selection

Set Anytype Selection

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SpaceSelection"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/spaces/anytype/statusAnytype Status

Anytype Status

Параметр	Где	Обязателен	Описание / схема
`refresh`	query	Нет	{ "default": false, "title": "Refresh", "type": "boolean" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/spaces/anytype/syncSync Anytype

Sync Anytype

Ответы

{
  "202": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PATCH/api/spaces/{space_id}/iconUpdate Space Icon

Update Space Icon

Параметр	Где	Обязателен	Описание / схема
`space_id`	path	Да	{ "title": "Space Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SpaceIcon"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/api/spaces/{space_id}/vector-searchVector Search Status

Vector Search Status

Параметр	Где	Обязателен	Описание / схема
`space_id`	path	Да	{ "title": "Space Id", "type": "integer" }

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PATCH/api/spaces/{space_id}/vector-searchUpdate Vector Search

Update Vector Search

Параметр	Где	Обязателен	Описание / схема
`space_id`	path	Да	{ "title": "Space Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/VectorSearchMode"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

POST/api/spaces/{space_id}/vector-search/indexBuild Space Index

Build Space Index

Параметр	Где	Обязателен	Описание / схема
`space_id`	path	Да	{ "title": "Space Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BuildSpaceIndex"
      }
    }
  },
  "required": true
}

Ответы

{
  "202": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

PUT/api/spaces/{space_id}/vector-search/processingUpdate Processing

Update Processing

Параметр	Где	Обязателен	Описание / схема
`space_id`	path	Да	{ "title": "Space Id", "type": "integer" }

Тело запроса

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SpaceProcessingSettings"
      }
    }
  },
  "required": true
}

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Безопасность в OpenAPI

[
  {
    "APIKeyHeader": []
  }
]

GET/healthHealth

Health

Ответы

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  }
}

Схемы данных#

AddFavoriteRequest

{
  "properties": {
    "page_number": {
      "title": "Page Number",
      "type": "integer"
    },
    "pdf_id": {
      "title": "Pdf Id",
      "type": "integer"
    }
  },
  "required": [
    "pdf_id",
    "page_number"
  ],
  "title": "AddFavoriteRequest",
  "type": "object"
}

Body_replace_document_api_pdfs__pdf_id__replace_post

{
  "properties": {
    "file": {
      "contentMediaType": "application/octet-stream",
      "title": "File",
      "type": "string"
    }
  },
  "required": [
    "file"
  ],
  "title": "Body_replace_document_api_pdfs__pdf_id__replace_post",
  "type": "object"
}

Body_upload_pdf_api_pdfs_post

{
  "properties": {
    "file": {
      "contentMediaType": "application/octet-stream",
      "title": "File",
      "type": "string"
    },
    "skip_indexing": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skip Indexing"
    },
    "space_id": {
      "default": 1,
      "title": "Space Id",
      "type": "integer"
    },
    "tags": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    }
  },
  "required": [
    "file"
  ],
  "title": "Body_upload_pdf_api_pdfs_post",
  "type": "object"
}

BuildSpaceIndex

{
  "properties": {
    "action": {
      "enum": [
        "create",
        "rebuild"
      ],
      "title": "Action",
      "type": "string"
    }
  },
  "required": [
    "action"
  ],
  "title": "BuildSpaceIndex",
  "type": "object"
}

CreateSpace

{
  "properties": {
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "CreateSpace",
  "type": "object"
}

DuplicatePairSchema

{
  "properties": {
    "detected_at": {
      "title": "Detected At",
      "type": "string"
    },
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "matched_pages": {
      "title": "Matched Pages",
      "type": "integer"
    },
    "page_matches": {
      "default": [],
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Page Matches",
      "type": "array"
    },
    "pdf_created_existing": {
      "title": "Pdf Created Existing",
      "type": "string"
    },
    "pdf_created_new": {
      "title": "Pdf Created New",
      "type": "string"
    },
    "pdf_id_existing": {
      "title": "Pdf Id Existing",
      "type": "integer"
    },
    "pdf_id_new": {
      "title": "Pdf Id New",
      "type": "integer"
    },
    "pdf_name_existing": {
      "title": "Pdf Name Existing",
      "type": "string"
    },
    "pdf_name_new": {
      "title": "Pdf Name New",
      "type": "string"
    },
    "pdf_page_count_existing": {
      "title": "Pdf Page Count Existing",
      "type": "integer"
    },
    "pdf_page_count_new": {
      "title": "Pdf Page Count New",
      "type": "integer"
    },
    "similarity_score": {
      "title": "Similarity Score",
      "type": "number"
    },
    "total_pages_new": {
      "title": "Total Pages New",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "pdf_id_new",
    "pdf_name_new",
    "pdf_page_count_new",
    "pdf_created_new",
    "pdf_id_existing",
    "pdf_name_existing",
    "pdf_page_count_existing",
    "pdf_created_existing",
    "similarity_score",
    "matched_pages",
    "total_pages_new",
    "detected_at"
  ],
  "title": "DuplicatePairSchema",
  "type": "object"
}

EmbedderInfo

{
  "properties": {
    "description": {
      "title": "Description",
      "type": "string"
    },
    "dims_default": {
      "default": 128,
      "title": "Dims Default",
      "type": "integer"
    },
    "download_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Download Error"
    },
    "downloaded": {
      "default": false,
      "title": "Downloaded",
      "type": "boolean"
    },
    "downloaded_bytes": {
      "default": 0,
      "title": "Downloaded Bytes",
      "type": "integer"
    },
    "downloading": {
      "default": false,
      "title": "Downloading",
      "type": "boolean"
    },
    "index_bytes": {
      "default": 0,
      "title": "Index Bytes",
      "type": "integer"
    },
    "index_database_bytes": {
      "default": 0,
      "title": "Index Database Bytes",
      "type": "integer"
    },
    "index_files_bytes": {
      "default": 0,
      "title": "Index Files Bytes",
      "type": "integer"
    },
    "indexed_pages": {
      "default": 0,
      "title": "Indexed Pages",
      "type": "integer"
    },
    "indexed_pdfs": {
      "default": 0,
      "title": "Indexed Pdfs",
      "type": "integer"
    },
    "loaded": {
      "default": false,
      "title": "Loaded",
      "type": "boolean"
    },
    "local_supported": {
      "default": true,
      "title": "Local Supported",
      "type": "boolean"
    },
    "memory_bytes": {
      "default": 0,
      "title": "Memory Bytes",
      "type": "integer"
    },
    "memory_devices": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Memory Devices",
      "type": "array"
    },
    "model_id": {
      "default": "",
      "title": "Model Id",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "required_models": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Required Models",
      "type": "array"
    },
    "size_bytes": {
      "default": 0,
      "title": "Size Bytes",
      "type": "integer"
    },
    "supports_heatmap": {
      "default": true,
      "title": "Supports Heatmap",
      "type": "boolean"
    },
    "total_bytes": {
      "default": 0,
      "title": "Total Bytes",
      "type": "integer"
    },
    "total_pages": {
      "default": 0,
      "title": "Total Pages",
      "type": "integer"
    },
    "total_pdfs": {
      "default": 0,
      "title": "Total Pdfs",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "description"
  ],
  "title": "EmbedderInfo",
  "type": "object"
}

EnqueueRequest

{
  "properties": {
    "force": {
      "default": false,
      "title": "Force",
      "type": "boolean"
    },
    "kind": {
      "default": "ocr",
      "enum": [
        "ocr",
        "text"
      ],
      "title": "Kind",
      "type": "string"
    },
    "pdf_ids": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "maxItems": 10000,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pdf Ids"
    },
    "space_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Space Id"
    }
  },
  "title": "EnqueueRequest",
  "type": "object"
}

FavoriteItem

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "image_url": {
      "title": "Image Url",
      "type": "string"
    },
    "page_number": {
      "title": "Page Number",
      "type": "integer"
    },
    "pdf_filename": {
      "title": "Pdf Filename",
      "type": "string"
    },
    "pdf_id": {
      "title": "Pdf Id",
      "type": "integer"
    },
    "tags": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    }
  },
  "required": [
    "id",
    "pdf_id",
    "page_number",
    "created_at",
    "pdf_filename",
    "image_url"
  ],
  "title": "FavoriteItem",
  "type": "object"
}

HTTPValidationError

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "title": "Detail",
      "type": "array"
    }
  },
  "title": "HTTPValidationError",
  "type": "object"
}

IndexingStatusResponse

{
  "properties": {
    "active_job": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Active Job"
    },
    "active_jobs": {
      "default": [],
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Active Jobs",
      "type": "array"
    },
    "jobs": {
      "default": [],
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Jobs",
      "type": "array"
    },
    "paused": {
      "title": "Paused",
      "type": "boolean"
    },
    "queue_size": {
      "title": "Queue Size",
      "type": "integer"
    }
  },
  "required": [
    "paused",
    "queue_size"
  ],
  "title": "IndexingStatusResponse",
  "type": "object"
}

LocalSearchFallback

{
  "properties": {
    "downloaded": {
      "title": "Downloaded",
      "type": "boolean"
    },
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name",
    "downloaded"
  ],
  "title": "LocalSearchFallback",
  "type": "object"
}

MetadataItem

{
  "properties": {
    "key": {
      "title": "Key",
      "type": "string"
    },
    "value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Value"
    }
  },
  "required": [
    "key"
  ],
  "title": "MetadataItem",
  "type": "object"
}

MetadataUpdateRequest

{
  "properties": {
    "metadata": {
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ]
      },
      "title": "Metadata",
      "type": "object"
    }
  },
  "required": [
    "metadata"
  ],
  "title": "MetadataUpdateRequest",
  "type": "object"
}

MoveDocumentsRequest

{
  "properties": {
    "pdf_ids": {
      "items": {
        "type": "integer"
      },
      "maxItems": 10000,
      "minItems": 1,
      "title": "Pdf Ids",
      "type": "array"
    },
    "target_space_id": {
      "title": "Target Space Id",
      "type": "integer"
    }
  },
  "required": [
    "pdf_ids",
    "target_space_id"
  ],
  "title": "MoveDocumentsRequest",
  "type": "object"
}

PDFListItem

{
  "properties": {
    "auto_tags": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Auto Tags",
      "type": "array"
    },
    "conversion_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Conversion Error"
    },
    "conversion_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Conversion Status"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "display_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Display Name"
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Message"
    },
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "media_type": {
      "default": "application/pdf",
      "title": "Media Type",
      "type": "string"
    },
    "model_indexed": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model Indexed"
    },
    "original_filename": {
      "title": "Original Filename",
      "type": "string"
    },
    "page_count": {
      "title": "Page Count",
      "type": "integer"
    },
    "source": {
      "default": "local",
      "title": "Source",
      "type": "string"
    },
    "space_id": {
      "default": 1,
      "title": "Space Id",
      "type": "integer"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "tags": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    },
    "version": {
      "default": 1,
      "title": "Version",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "original_filename",
    "page_count",
    "status",
    "created_at"
  ],
  "title": "PDFListItem",
  "type": "object"
}

PDFResponse

{
  "properties": {
    "conversion_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Conversion Error"
    },
    "conversion_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Conversion Status"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "display_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Display Name"
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Message"
    },
    "filename": {
      "title": "Filename",
      "type": "string"
    },
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "md5_hash": {
      "title": "Md5 Hash",
      "type": "string"
    },
    "media_type": {
      "default": "application/pdf",
      "title": "Media Type",
      "type": "string"
    },
    "metadata": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/MetadataItem"
      },
      "title": "Metadata",
      "type": "array"
    },
    "original_filename": {
      "title": "Original Filename",
      "type": "string"
    },
    "page_count": {
      "title": "Page Count",
      "type": "integer"
    },
    "source": {
      "default": "local",
      "title": "Source",
      "type": "string"
    },
    "space_id": {
      "default": 1,
      "title": "Space Id",
      "type": "integer"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "tags": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/TagSchema"
      },
      "title": "Tags",
      "type": "array"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    },
    "version": {
      "default": 1,
      "title": "Version",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "filename",
    "original_filename",
    "md5_hash",
    "page_count",
    "status",
    "created_at",
    "updated_at"
  ],
  "title": "PDFResponse",
  "type": "object"
}

RenameRequest

{
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "RenameRequest",
  "type": "object"
}

ResolveDuplicateRequest

{
  "properties": {
    "action": {
      "title": "Action",
      "type": "string"
    }
  },
  "required": [
    "action"
  ],
  "title": "ResolveDuplicateRequest",
  "type": "object"
}

SearchResponse

{
  "properties": {
    "embedder_name": {
      "default": "",
      "title": "Embedder Name",
      "type": "string"
    },
    "external_unavailable": {
      "default": false,
      "title": "External Unavailable",
      "type": "boolean"
    },
    "local_fallback": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/LocalSearchFallback"
        },
        {
          "type": "null"
        }
      ]
    },
    "query": {
      "title": "Query",
      "type": "string"
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/SearchResultItem"
      },
      "title": "Results",
      "type": "array"
    },
    "semantic_weight": {
      "default": 0.5,
      "title": "Semantic Weight",
      "type": "number"
    },
    "total": {
      "title": "Total",
      "type": "integer"
    },
    "unindexed_pages": {
      "default": 0,
      "title": "Unindexed Pages",
      "type": "integer"
    },
    "unindexed_pdfs": {
      "default": 0,
      "title": "Unindexed Pdfs",
      "type": "integer"
    },
    "warnings": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Warnings",
      "type": "array"
    }
  },
  "required": [
    "query",
    "results",
    "total"
  ],
  "title": "SearchResponse",
  "type": "object"
}

SearchResultItem

{
  "properties": {
    "bm25_score": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bm25 Score"
    },
    "image_url": {
      "title": "Image Url",
      "type": "string"
    },
    "is_favorite": {
      "default": false,
      "title": "Is Favorite",
      "type": "boolean"
    },
    "match_types": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Match Types",
      "type": "array"
    },
    "media_type": {
      "default": "application/pdf",
      "title": "Media Type",
      "type": "string"
    },
    "page_number": {
      "title": "Page Number",
      "type": "integer"
    },
    "pdf_filename": {
      "title": "Pdf Filename",
      "type": "string"
    },
    "pdf_id": {
      "title": "Pdf Id",
      "type": "integer"
    },
    "score": {
      "title": "Score",
      "type": "number"
    },
    "semantic_score": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Semantic Score"
    },
    "snippet": {
      "default": "",
      "title": "Snippet",
      "type": "string"
    },
    "source": {
      "default": "local",
      "title": "Source",
      "type": "string"
    },
    "space_id": {
      "default": 1,
      "title": "Space Id",
      "type": "integer"
    },
    "tags": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    },
    "text_layer": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Text Layer"
    },
    "text_sources": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Text Sources",
      "type": "array"
    },
    "text_url": {
      "default": "",
      "title": "Text Url",
      "type": "string"
    },
    "vector_id": {
      "title": "Vector Id",
      "type": "string"
    }
  },
  "required": [
    "pdf_id",
    "pdf_filename",
    "page_number",
    "score",
    "image_url",
    "vector_id"
  ],
  "title": "SearchResultItem",
  "type": "object"
}

SettingsResponse

{
  "properties": {
    "settings": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Settings",
      "type": "object"
    }
  },
  "required": [
    "settings"
  ],
  "title": "SettingsResponse",
  "type": "object"
}

SettingsUpdateRequest

{
  "properties": {
    "settings": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Settings",
      "type": "object"
    }
  },
  "required": [
    "settings"
  ],
  "title": "SettingsUpdateRequest",
  "type": "object"
}

SpaceIcon

{
  "properties": {
    "icon": {
      "anyOf": [
        {
          "maxLength": 350000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Icon"
    }
  },
  "title": "SpaceIcon",
  "type": "object"
}

SpaceProcessingSettings

{
  "properties": {
    "indexing_batch_size": {
      "maximum": 32,
      "minimum": 1,
      "title": "Indexing Batch Size",
      "type": "integer"
    },
    "pdf_dpi": {
      "maximum": 300,
      "minimum": 72,
      "title": "Pdf Dpi",
      "type": "integer"
    },
    "pool_factor": {
      "maximum": 10,
      "minimum": 1,
      "title": "Pool Factor",
      "type": "integer"
    }
  },
  "required": [
    "pool_factor",
    "indexing_batch_size",
    "pdf_dpi"
  ],
  "title": "SpaceProcessingSettings",
  "type": "object"
}

SpaceSelection

{
  "properties": {
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "space_ids": {
      "items": {
        "type": "integer"
      },
      "maxItems": 10000,
      "title": "Space Ids",
      "type": "array"
    }
  },
  "required": [
    "space_ids",
    "enabled"
  ],
  "title": "SpaceSelection",
  "type": "object"
}

TagSchema

{
  "properties": {
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "title": "TagSchema",
  "type": "object"
}

TagsUpdateRequest

{
  "properties": {
    "tags": {
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    }
  },
  "required": [
    "tags"
  ],
  "title": "TagsUpdateRequest",
  "type": "object"
}

ValidationError

{
  "properties": {
    "ctx": {
      "title": "Context",
      "type": "object"
    },
    "input": {
      "title": "Input"
    },
    "loc": {
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          }
        ]
      },
      "title": "Location",
      "type": "array"
    },
    "msg": {
      "title": "Message",
      "type": "string"
    },
    "type": {
      "title": "Error Type",
      "type": "string"
    }
  },
  "required": [
    "loc",
    "msg",
    "type"
  ],
  "title": "ValidationError",
  "type": "object"
}

VectorSearchMode

{
  "properties": {
    "mode": {
      "enum": [
        "memory",
        "plaid"
      ],
      "title": "Mode",
      "type": "string"
    }
  },
  "required": [
    "mode"
  ],
  "title": "VectorSearchMode",
  "type": "object"
}

Нашли неточность? Сообщите на GitHub ↗