Find similar news

GET

https://api.aventure.vc/v1/news/similar

GET

/v1/news/similar

$ curl -G https://api.aventure.vc/v1/news/similar \
>      -H "X-Client-Secret: <apiKey>" \
>      -d embeddingModel=qwen-4b-fp16

1 {
2   "content": [
3     {
4       "id": 1,
5       "title": "string",
6       "author": "string",
7       "category": "string",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "excerpt": "string",
10       "externalNewsArticle": true,
11       "newsImageThumbnail": "string",
12       "newsUrlOriginal": "string",
13       "pendingApproval": 1,
14       "publication": "string",
15       "publishedAt": "2024-01-15T09:30:00Z",
16       "slug": "aventure-vc",
17       "updatedAt": "2024-01-15T09:30:00Z"
18     }
19   ],
20   "empty": true,
21   "first": true,
22   "last": true,
23   "number": 1,
24   "numberOfElements": 1,
25   "pageable": {
26     "offset": 1,
27     "pageNumber": 1,
28     "pageSize": 1,
29     "paged": true,
30     "sort": {
31       "empty": true,
32       "sorted": true,
33       "unsorted": true
34     },
35     "unpaged": true
36   },
37   "size": 1,
38   "sort": {
39     "empty": true,
40     "sorted": true,
41     "unsorted": true
42   },
43   "totalElements": 1,
44   "totalPages": 1
45 }

Returns news articles similar to the article specified by exactly one id or slug. When similarity stages return nothing, falls back to recent articles excluding the target. The similarity embedding model is pinned to qwen-4b-fp16; embeddingModel, when provided, must equal qwen-4b-fp16. Source: https://huggingface.co/Qwen/Qwen3-Embedding-4B-GGUF?show_file_info=Qwen3-Embedding-4B-f16.gguf.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

idintegerOptional

News article id — exactly one of id or slug is required.

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

News article slug — exactly one of id or slug is required.

embeddingModelenumOptional

Pinned similarity embedding model

Allowed values:

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 4

The size of the page to be returned

sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

contentlist of objectsOptional

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberintegerOptional

numberOfElementsintegerOptional

pageableobjectOptional

sizeintegerOptional

sortobjectOptional

totalElementslongOptional

totalPagesintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error