API Documentation
← All tools
GET/api/v1/tools/resolution/autocomplete

Entity Autocomplete

resolution

Resolve a sponsor / organization name to canonical organization ids ('organizations/<key>'). Despite the generic tool name, this endpoint covers SPONSORS / ORGANIZATIONS ONLY (companies, universities and institutions) - drug, disease and target names will not match (use diseases.autocomplete for disease CURIEs; drugs and targets resolve inside their own domain tools). Each returned row is either a resolved canonical entity (hierarchyLevel 'GLOBAL PARENT', with rorId / lei populated) or an unresolved raw mention (hierarchyLevel 'UNRESOLVED', rorId / lei null); both id forms are directly usable wherever an organization id is expected, e.g. the sponsor_id filter of Regulatory Approvals Search or grants.sponsor-funding. Rows are returned only for organizations with at least one linked trial - a real sponsor with zero linked trials yields no rows.

When to use it

  • resolve a sponsor / company / university name to an organization id
  • disambiguate sponsors before sponsor_id or organization-id filters

Getting started

Base URL

https://app.caelrith.com/api/v1/tools

Authentication

Include your API key in the x-api-key header.

Parameters

Query parameters

ParameterTypeRequiredDescription
querystringYesPartial or full SPONSOR / organization name to autocomplete (e.g. 'pfizer', 'moderna'). Drug, disease and target names will not match on this endpoint.
limitintegerNoMaximum number of suggestions (1-50, default 10).
Range: 1 to 50

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/tools/resolution/autocomplete?query=your_query"

Response envelope

Successful responses wrap the payload in a success flag.

{
  "success": true,
  "data": { /* payload */ },
  "meta": { /* pagination, totals */ }
}

Response shape

List responseENTITIES

Payload: data — Entities

Common row fields

FieldDescription
nameName
hierarchyLevelLevel
trialCountTrials
approvalCountApprovals
idRecord identifier
isEntity—

Empty results: No matching rows (HTTP 200)

Sponsors / organizations only, despite the generic tool name. id is an 'organizations/<key>' document id - directly usable as sponsor_id / organization id in other tools (Regulatory Approvals Search, grants.sponsor-funding). hierarchyLevel: 'GLOBAL PARENT' = resolved canonical entity with rorId / lei populated; 'UNRESOLVED' = raw mention not yet linked to a canonical entity (rorId / lei null). Rows are FILTERED to organizations with at least one linked trial - a real sponsor with zero linked trials returns an empty list, so no_results here is not proof the organization is absent from the graph.

Catalog version 0.0.0-generated · generated from the API source