Appearance
Referential Data API (REST)
Use the reference endpoints to populate language and country selectors. Both require Read or Admin rights and the authentication headers.
| Method | Path | Result |
|---|---|---|
GET | /referential/languages | Language codes and display labels |
GET | /referential/countries | Country, region, and subregion data |
Languages
bash
curl --fail-with-body "$BLUECURVE_API_URL/referential/languages" \
-H "x-api-key: $BLUECURVE_API_KEY" \
-H 'api-version: 1.0'The response is an array with code and label properties:
json
[
{ "code": "ENG", "label": "English (English)" },
{ "code": "FRA", "label": "French (français)" }
]Use the returned code for search language hints. For stopword uploads, query the separate supported stopword languages endpoint.
Countries
GET /referential/countries returns objects with this shape:
json
[
{
"name": "France",
"englishName": "France",
"codeAlpha2": "FR",
"codeAlpha3": "FRA",
"region": "Europe",
"subRegion": "Western Europe"
}
]Use the returned codes rather than deriving identifiers from display names. Reference values can be cached by clients; they are not task status or ingestion progress.
Success returns 200 with JSON. Missing authentication or rights returns 401/403; a processing failure can return 500. Check the HTTP status before reading the body.
Next: Getting Started