Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Novu Translations API

Used to localize your notifications to different languages.

Novu Translations API is one of 19 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Translations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.

This API exposes 9 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 3.15.0.

Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.

9 operations 7 paths 7 schemas 2 DELETE3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.15.0
Base URL
https://api.novu.co
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Novu Translations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretKey). By default, every request must be authenticated.

  • secretKey — API key authentication. Allowed headers-- "Authorization: ApiKey ".

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Translations 9

Used to localize your notifications to different languages.

POST
/v2/translations/upload
Novu Upload Translation Files
TranslationController_uploadTranslationFiles body → 200
POST
/v2/translations
Novu Create a Translation
TranslationController_createTranslationEndpoint body → 200
GET
/v2/translations/master-json
Novu Retrieve Master Translations JSON
TranslationController_getMasterJsonEndpoint 1 param → 200
POST
/v2/translations/master-json
Novu Import Master Translations JSON
TranslationController_importMasterJsonEndpoint body → 200
POST
/v2/translations/master-json/upload
Novu Upload Master Translations JSON File
TranslationController_uploadMasterJsonEndpoint body → 200
GET
/v2/translations/group/{resourceType}/{resourceId}
Novu Retrieve a Translation Group
TranslationController_getTranslationGroupEndpoint 2 params → 200404
GET
/v2/translations/{resourceType}/{resourceId}/{locale}
Novu Retrieve a Translation
TranslationController_getSingleTranslation 3 params → 200404
DELETE
/v2/translations/{resourceType}/{resourceId}/{locale}
Novu Delete a Translation
TranslationController_deleteTranslationEndpoint 3 params → 204404
DELETE
/v2/translations/{resourceType}/{resourceId}
Novu Delete a Translation Group
TranslationController_deleteTranslationGroupEndpoint 2 params → 204404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TranslationGroupDto (7 properties), TranslationResponseDto (6 properties), CreateTranslationRequestDto (4 properties), UploadTranslationsResponseDto (4 properties). Each schema is shown below with its type and property counts.

ImportMasterJsonResponseDto
object
4 properties 2 required
GetMasterJsonResponseDto
object
2 properties 2 required
UploadTranslationsResponseDto
object
4 properties 4 required
TranslationGroupDto
object
7 properties 6 required
ImportMasterJsonRequestDto
object
2 properties 2 required
CreateTranslationRequestDto
object
4 properties 4 required
TranslationResponseDto
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-translations-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API