POST /assets

Add a new translatable asset

POST https://localise.biz/api/assets

Adds a new asset to the currently authenticated project. When created successfully the response will be 201 (created).

Specifying {text} also creates an initial source language translation (unless you also specify default=untranslated).

URI parameters

key

API key - required if not sent in Authorization header

string

optional

POST parameters

`id`	Unique asset ID up to 999 bytes (leave blank to auto-generate)	string	optional
`text`	Initial source language translation (required if `{id}` is empty)	string	optional
`type`	Content type for all translations of the new asset	`text` \| `html` \| `xml`	default: `"text"`
`context`	Optional context descriptor	string	optional
`notes`	Optional notes for translators	string	optional
`default`	Status of the source language translation specified in `{text}`	string	default: `"translated"`

Request headers

Authorization

API key sent as "Loco <key>" or "Basic <encoded>". See Authentication.

string

required if not in query

Response

A single JSON-encoded Asset object, which takes the following form:

{
    "id": "", // Unique asset identifier
    "type": "text", // Content type for translations
    "context": "", // Optional context descriptor
    "notes": "", // Optional notes for translators
    "printf": "", // String formatting style
    "created": "", // Time first added in UTC
    "modified": "", // Time last modified in UTC
    "plurals": 0, // Number of associated plural forms
    "tags": [ /* Array of terms asset is tagged with */ ],
    "aliases": { /* Hash of additional asset identifiers, e.g */ },
    "progress": {
        "translated": 0, // Number of locales for which a translation exists (including those flagged)
        "untranslated": 0, // Number of locales that do not yet have a translation of this asset
        "flagged": 0, // Number of locales whose translations are flagged as requiring attention
    }
}

Try it

Open in test console »

« /api/assets