v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Uploads

Upload a new file

Upload a new language file. Creates necessary resources in your project.

Note: be aware of upload limits.

post/projects/{project_id}/uploads

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

Created

idstring
filenamestring
formatstring
statestring
tagstring

Unique tag of the upload

tagsstring[]

List of tags that were assigned to the uploaded keys

urlstring

The URL to the upload in Phrase Strings app.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "filename": "example.json",
  "format": "json",
  "state": "success",
  "tag": "tag",
  "summary": {
    "locales_created": 2,
    "translation_keys_created": 162,
    "translation_keys_updated": 10,
    "translation_keys_unmentioned": 0,
    "translations_created": 291,
    "translations_updated": 3,
    "tags_created": 2,
    "translation_keys_ignored": 0
  },
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "johndoe",
    "name": "John Doe",
    "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}