Skip to main content
POST
/
med-link
/
nel
/
link
/
batch
Link entities (batch)
curl --request POST \
  --url https://api.eka.care/med-link/nel/link/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queries": [
    "fever",
    "headache"
  ],
  "ontology": "snomed",
  "version": "20250401_extended",
  "top_k": 2
}
'
{
  "results": [
    {
      "request_id": "e4b280cf-40a1-4a83-9f25-f7f07f3766ed",
      "query": "fever",
      "query_breakdown": null,
      "ontology": "snomed",
      "version": "20250401_extended",
      "index_name": "snomed_20250401_extended_c88b15811956d4fcb54da9ae_1bfcc90540_pg",
      "model_version": "c88b15811956d4fcb54da9ae6d14a733ac90e7a7",
      "results": [
        {
          "term_id": "386661006",
          "term_name": "Febrile",
          "score": 0.89858478307724,
          "is_linked": true,
          "metadata": {
            "semantic_tag": "finding",
            "is_core": true,
            "source": "snomed_ct_20250401_extended",
            "language": "en",
            "script": "latin"
          }
        }
      ]
    },
    {
      "request_id": "e4b280cf-40a1-4a83-9f25-f7f07f3766ed",
      "query": "headache",
      "query_breakdown": null,
      "ontology": "snomed",
      "version": "20250401_extended",
      "index_name": "snomed_20250401_extended_c88b15811956d4fcb54da9ae_1bfcc90540_pg",
      "model_version": "c88b15811956d4fcb54da9ae6d14a733ac90e7a7",
      "results": [
        {
          "term_id": "25064002",
          "term_name": "Headache",
          "score": 0.9999999403953606,
          "is_linked": true,
          "metadata": {
            "semantic_tag": "finding",
            "is_core": true,
            "source": "snomed_ct_20250401_extended",
            "language": "en",
            "script": "latin"
          }
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.eka.care/llms.txt

Use this file to discover all available pages before exploring further.

About this endpoint

POST /med-link/nel/link/batch links up to 5 free-text entities in a single call. Every query in the batch shares the same ontology, version, top_k and metadata. The response results[] array contains one block per query, in request order — each block has the same shape as a single Link Entity response.

When to use it

  • Coding several entities from the same document (e.g. all symptoms in a note).
  • Reducing round-trips when the ontology and metadata are identical.
Because metadata is shared across the whole batch, group queries that need different hints — especially LOINC tests with different units or specimens — into separate batches, or use the single Link Entity endpoint.

Limits

ConstraintValue
Queries per request1–5
top_k1–10 (default 5)

Authorizations

Authorization
string
header
required

Bearer access token issued by the Eka authorization flow. See Authorization.

Body

application/json
queries
string[]
required

List of free-text entities to link (1–5).

Required array length: 1 - 5 elements
ontology
string
required

Ontology name applied to every query in the batch.

Example:

"snomed"

version
string
required

Ontology version applied to every query in the batch.

Example:

"20250401_extended"

top_k
integer
default:5

Number of candidate results to return per query.

Required range: 1 <= x <= 10
metadata
object

Ontology-specific hints applied to every query in the batch.

request_id
string | null

Optional request ID. Generated automatically if omitted.

Response

One result block per query, in request order.

results
object[]
required

One NELResponse per query, in request order.