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

Weblate units API

A unit is a single piece of a translation which pairs a source string with a corresponding translated string and also contains some related metadata. The term is derived from the Translate Toolkit and XLIFF.

Weblate units API is one of 21 APIs that Weblate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include units. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 4 paths, and defines 42 schemas. It is described by OpenAPI 3.1.1.

Requests are made against a single base URL, http:.

8 operations 4 paths 42 schemas 1 DELETE4 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
Base URL
https://hosted.weblate.org/api/
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Weblate units API declares 3 security schemes for authenticating requests. An API key is passed in the header as Bearer (bearerAuth). An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Token (tokenAuth).

  • bearerAuth — Token-based authentication with required prefix Bearer. - Each user has a personal access token which they can get from their respective user profile. These to…
  • cookieAuth — Session-based authentication used when user is signed in.
  • tokenAuth — Token-based authentication with required prefix Token. - Each user has a personal access token which they can get from their respective user profile. These tok…

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

units 8

A unit is a single piece of a translation which pairs a source string with a corresponding translated string and also contains some related metadata. The term is derived from the…

GET
/api/units/
Return a list of translation units.
api_units_list 2 params → 400401403404405406423429
GET
/api/units/{id}/
Return information about translation unit.
api_units_retrieve 1 param → 400401403404405406423429
PUT
/api/units/{id}/
Perform full update on translation unit.
api_units_update 1 param body → 400401403404405406415423
PATCH
/api/units/{id}/
Perform partial update on translation unit.
api_units_partial_update 1 param body → 400401403404405406415423
DELETE
/api/units/{id}/
Delete a translation unit.
api_units_destroy 1 param → 400401403404405406423429
GET
/api/units/{id}/comments/
Return a list of comments on the unit.
api_units_comments_list 3 params → 400401403404405406423429
POST
/api/units/{id}/comments/
Add a comment to the unit.
api_units_comments_create 1 param body → 400401403404405406415423
GET
/api/units/{id}/translations/
Units API.
api_units_translations_retrieve 1 param → 400401403404405406423429

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Unit (32 properties), Comment (6 properties), PatchedUnitWrite (5 properties), UnitWrite (5 properties). Each schema is shown below with its type and property counts.

Unit
object
32 properties 21 required
Error415
object
3 properties 3 required
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed
Label
object
4 properties 2 required
Error423
object
3 properties 3 required
ColorEnum
string
navy - Navy blue - Blue aqua - Aqua teal - Teal olive - Olive green - Green lime - Lime yellow - Yellow orange - Orange red - Red maroon - Maroon fuchsia - Fuc…
ErrorResponse403
object
2 properties 2 required
ErrorResponse404
object
2 properties 2 required
ErrorCode429Enum
string
throttled - Throttled
ErrorCode401Enum
string
authenticationfailed - Authentication Failed notauthenticated - Not Authenticated
StringStateEnum
integer
0 - Empty 10 - Needs editing 11 - Needs editing (Needs rewriting) 12 - Needs editing (Needs checking) 20 - Translated 30 - Approved 100 - Read-only
ErrorCode403Enum
string
permissiondenied - Permission Denied
ErrorResponse415
object
2 properties 2 required
CommentScopeEnum
string
report - report global - global translation - translation
Error429
object
3 properties 3 required
Error406
object
3 properties 3 required
Error405
object
3 properties 3 required
Error400
object
3 properties 3 required
Error401
object
3 properties 3 required
PatchedUnitWrite
object
Serializer for updating source unit.
5 properties
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
UnitWrite
object
Serializer for updating source unit.
5 properties 2 required
Error500
object
3 properties 3 required
ErrorCode500Enum
string
error - Error
ServerErrorEnum
string
servererror - Server Error
Comment
object
6 properties 4 required
ErrorCode415Enum
string
unsupportedmediatype - Unsupported Media Type
PaginatedCommentList
object
4 properties 2 required
Error404
object
3 properties 3 required
ErrorCode404Enum
string
notfound - Not Found
ErrorResponse500
object
2 properties 2 required
ErrorResponse423
object
2 properties 2 required
Error403
object
3 properties 3 required
ErrorResponse401
object
2 properties 2 required
ErrorResponse429
object
2 properties 2 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
PaginatedUnitList
object
4 properties 2 required
ErrorResponse400
object
2 properties 2 required
ErrorResponse406
object
2 properties 2 required
ErrorResponse405
object
2 properties 2 required
ErrorCode406Enum
string
notacceptable - Not Acceptable
ClientErrorEnum
string
clienterror - Client Error

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weblate-units-api-openapi.yml Raw ↑

Other APIs Weblate publishes across the network.

Weblate addons API
Weblate categories API
Weblate changes API
Weblate component-lists API
Weblate components API
Weblate contributions API
Weblate groups API
Weblate hooks API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API