Language Files

Create a language file

Creates a language file of the account: the literals the widgets, the headers and the field names of a report are printed with, which /v1/reports/update then puts on a report with language_file.

BY FILE AND NOT LITERAL BY LITERAL, which is how the application writes one: file.content_base64 carries a .txt and the whole set of literals is stored from it. Download one with /v1/language-files/get -- one of the sixteen the platform ships is the usual starting point -- edit the values and send it here.

THE PARSER IS THE APPLICATION'S. UTF-8, one key = value per line, # for a comment, an apostrophe written as '. A line with two equals signs, a key that is there twice or a backslash is refused with the message of the parser, naming the line. Keys no field catalogue of the platform knows are DROPPED and counted: the answer says ignored_keys and carries a LANGUAGE_FILE_KEYS_IGNORED warning.

language is required: it is the ISO 639-1 code the literals are written in, and what the AI summaries of every report using this file are written in.

Creating a file changes no report until /v1/reports/update points one at it, and it empties no cached result.

Every write endpoint reads dry_run and idempotency_key; see the Write guarantees section of the introduction.

post/language-files/create

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/language-files/create
  • Auth: HTTP bearer

Request body

namestring required

How the file is listed in the account. 2 to 50 characters, with no character above the Basic Multilingual Plane.

languagestring required

The ISO 639-1 code the literals are written in, and the language the AI summaries of every report using this file are written in. The list is published by /v1/capabilities under language_files.languages.

internal_notesstring nullable

A note for the account's own staff, at most 250 characters.

language_file_keystring nullable

Accepted and ignored: part of what a read publishes and a creation has no column for. It comes back as a READ_ONLY_FIELD_IGNORED warning.

is_systemboolean nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

file_namestring nullable

Accepted and ignored: the name of the .txt is written through the file object. It comes back as a READ_ONLY_FIELD_IGNORED warning.

download_urlstring nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

download_url_expires_atstring nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

dry_runboolean

Validate everything and write nothing.

idempotency_keystring

Replays the answer of an identical call for 24 hours.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.