---
title: "POST /api/v1/similarity/project-documents-similarity-by-vectors/"
method: POST
path: "/api/v1/similarity/project-documents-similarity-by-vectors/"
tags: ["similarity", "v1"]
---

# POST /api/v1/similarity/project-documents-similarity-by-vectors/

`POST /api/v1/similarity/project-documents-similarity-by-vectors/`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/similarity/project-documents-similarity-by-vectors/`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/similarity/project-documents-similarity-by-vectors/post.ts> (a function with typed inputs; its response is checked against the schema)

"Similarity" admin task

POST params:
    - project_id: int
    - distance_type: str - see scipy.spatial.distance._METRICS
    - similarity_threshold: int
    - feature_source: "vector"
    - create_reverse_relations: bool - create B-A relations
    - item_id: int
    - use_tfidf: bool
    - delete: bool

## Request body

- ProjectDocumentsSimilarityByVectorsForm
  - `run_name` string, required
  - `similarity_threshold` integer, nullable
  - `project` integer, required
  - `feature_source` string, nullable
  - `distance_type` 'braycurtis' | 'canberra' | 'chebyshev' | 'cityblock' | 'correlation' | 'cosine' | 'dice' | 'euclidean' | 'hamming' | 'jaccard' | 'jensenshannon' | 'kulsinski' | 'kulczynski1' | 'mahalanobis' | 'minkowski' | 'rogerstanimoto' | 'russellrao' | 'seuclidean' | 'sokalmichener' | 'sokalsneath' | 'sqeuclidean' | 'yule', nullable
  - `item_id` integer, required
  - `create_reverse_relations` boolean, required
  - `use_tfidf` boolean, required
  - `delete` boolean, required

## Response `200`

- SimilarityPOSTObjectResponse
  - `detail` string, required
  - `task_id` string
  - `confirm` boolean

## Changes

- **2026-07-17** `3429f921b4cb`: 39 breaking, 3 info
  - the request property `create_reverse_relations` became not nullable (media type: application/json)
  - the request property `create_reverse_relations` became not nullable (media type: application/x-www-form-urlencoded)
  - the request property `create_reverse_relations` became not nullable (media type: multipart/form-data)
  - the request property `delete` became not nullable (media type: application/json)
  - …38 more
- **2021-05-24** `8167164be9cc`: 1 info
  - endpoint added
- **2020-12-11** `0957c4a7ae3d`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/similarity/project-documents-similarity-by-vectors/post.md)

---

[API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) - [All operations](https://skmtc.dev/lexpredict/apis/contraxsuite-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lexpredict/apis/contraxsuite-api/revisions/3429f921b4cb?raw)