Weblate components API
The components API from Weblate — 17 operation(s) for components.
Weblate components API is one of 21 APIs that Weblate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include components. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 25 operations across 17 paths, and defines 74 schemas. It is described by OpenAPI 3.1.1.
Requests are made against a single base URL, http:.
25 operations
17 paths
74 schemas
3 DELETE14 GET1 PATCH6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Weblate components 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 25
Across 17 paths, the API surfaces 25 operations — 3 DELETE, 14 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
components 25
GET
/api/components/
Return a list of translation components.
GET
/api/components/{project__slug}/{slug}/
Return information about translation component.
PUT
/api/components/{project__slug}/{slug}/
Edit a component by a PUT or PATCH request.
PATCH
/api/components/{project__slug}/{slug}/
Edit a component by a PATCH request.
DELETE
/api/components/{project__slug}/{slug}/
Delete a component.
POST
/api/components/{project__slug}/{slug}/addons/
Translation components API.
GET
/api/components/{project__slug}/{slug}/announcements/
Return announcements.
POST
/api/components/{project__slug}/{slug}/announcements/
Create an announcement.
DELETE
/api/components/{project__slug}/{slug}/announcements/{announcement_id}/
Delete an announcement.
GET
/api/components/{project__slug}/{slug}/changes/
Return a list of component changes.
GET
/api/components/{project__slug}/{slug}/credits/
Translation components API.
GET
/api/components/{project__slug}/{slug}/file/
Download all translation files in the component.
GET
/api/components/{project__slug}/{slug}/links/
Return projects linked with a component.
POST
/api/components/{project__slug}/{slug}/links/
Associate project with a component.
DELETE
/api/components/{project__slug}/{slug}/links/{project_slug}/
Remove association of a project with a component.
GET
/api/components/{project__slug}/{slug}/lock/
Return component lock status.
POST
/api/components/{project__slug}/{slug}/lock/
Sets component lock status.
GET
/api/components/{project__slug}/{slug}/monolingual_base/
Download base file for monolingual translations.
GET
/api/components/{project__slug}/{slug}/new_template/
Download template file for new translations.
GET
/api/components/{project__slug}/{slug}/repository/
Return information about VCS repository status.
POST
/api/components/{project__slug}/{slug}/repository/
Perform given operation on the VCS repository.
GET
/api/components/{project__slug}/{slug}/screenshots/
Return a list of component screenshots.
GET
/api/components/{project__slug}/{slug}/statistics/
Return paginated statistics for all translations within component.
GET
/api/components/{project__slug}/{slug}/translations/
Return a list of translation objects in the given component.
POST
/api/components/{project__slug}/{slug}/translations/
Create a new translation in the given component.
Schemas 74
The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are PatchedComponent (93 properties), Component (93 properties), Project (61 properties), Statistics (37 properties). Each schema is shown below with its type and property counts.
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…
PaginatedStatisticsList
object
4 properties
2 required
ErrorResponse404
object
2 properties
2 required
ErrorResponse415
object
2 properties
2 required
PaginatedAnnouncementList
object
4 properties
2 required
Error401
object
3 properties
3 required
FileFormatEnum
string
apple-xliff - XLIFF 1.2 with Apple extensions appstore - App store metadata files arb - ARB file aresource - Android String Resource asciidoc - AsciiDoc file a…
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
Change
object
13 properties
9 required
PriorityEnum
integer
60 - Very high 80 - High 100 - Medium 120 - Low 140 - Very low
ErrorCode500Enum
string
error - Error
CommitInfo
object
Detailed information about a Git commit.
12 properties
ErrorCode404Enum
string
notfound - Not Found
Screenshot
object
7 properties
6 required
Error403
object
3 properties
3 required
ComponentTranslationResponse
object
1 property
1 required
ErrorResponse429
object
2 properties
2 required
SeverityEnum
string
info - Info (light blue) warning - Warning (yellow) danger - Danger (red) success - Success (green)
ErrorResponse400
object
2 properties
2 required
PendingUnits
object
Detailed breakdown of pending translation units.
4 properties
4 required
MergeStyleEnum
string
merge - Merge rebase - Rebase mergenoff - Merge without fast-forward
ComponentLinkResponse
object
1 property
1 required
ErrorCode406Enum
string
notacceptable - Not Acceptable
PaginatedComponentTranslationList
object
4 properties
2 required
Error415
object
3 properties
3 required
PatchedComponent
object
93 properties
Error423
object
3 properties
3 required
PaginatedChangeList
object
4 properties
2 required
SourceEnum
integer
0 - Default plural 1 - gettext plural formula 3 - CLDR plural with zero 4 - CLDR v38+ plural 5 - Android plural 6 - Qt Linguist plural 2 - Manually entered for…
LanguagePlural
object
5 properties
2 required
Statistics
object
37 properties
33 required
Error429
object
3 properties
3 required
PaginatedComponentList
object
4 properties
2 required
Error400
object
3 properties
3 required
Lock
object
1 property
ComponentLinkRequest
object
2 properties
1 required
ErrorResponse423
object
2 properties
2 required
ActionEnum
integer
0 - Resource updated 1 - Translation completed 2 - Translation changed 3 - Comment added 4 - Suggestion added 5 - Translation added 6 - Automatically translate…
ErrorResponse401
object
2 properties
2 required
RepoRequest
object
1 property
1 required
BlankEnum
ErrorResponse406
object
2 properties
2 required
Announcement
object
5 properties
2 required
ComponentTranslation
object
32 properties
30 required
ErrorResponse403
object
2 properties
2 required
ErrorCode401Enum
string
authenticationfailed - Authentication Failed notauthenticated - Not Authenticated
ErrorCode403Enum
string
permissiondenied - Permission Denied
DirectionEnum
string
- Automatically detect text direction ltr - Left to right rtl - Right to left
LockRequest
object
1 property
1 required
LanguageCodeStyleEnum
string
- Default based on the file format posix - POSIX style using underscore as a separator posixlowercase - POSIX style using underscore as a separator, lower case…
TranslationCreate
object
2 properties
1 required
PaginatedScreenshotList
object
4 properties
2 required
ServerErrorEnum
string
servererror - Server Error
ErrorCode415Enum
string
unsupportedmediatype - Unsupported Media Type
PaginatedProjectList
object
4 properties
2 required
VcsEnum
string
gerrit - Gerrit git - Git git-force-push - Git with force push local - No remote repository mercurial - Mercurial subversion - Subversion
ErrorResponse405
object
2 properties
2 required
OperationEnum
string
commit - Commit pull - Update pull-rebase - Update with rebase pull-merge - Update with merge pull-merge-noff - Update with merge without fast-forward push - P…
ErrorCode429Enum
string
throttled - Throttled
Language
object
10 properties
6 required
NewLangEnum
string
contact - Contact maintainers url - Point to translation instructions URL add - Create new language file none - Disable adding new translations
Repository
object
Serializer for repository status information.
11 properties
4 required
Error406
object
3 properties
3 required
Error405
object
3 properties
3 required
Error500
object
3 properties
3 required
Component
object
93 properties
34 required
CommitPolicyEnum
integer
0 - Commit all translations regardless of quality 20 - Skip translations marked as needing editing 30 - Only include approved translations
RepositoryOperation
object
2 properties
1 required
Error404
object
3 properties
3 required
Project
object
61 properties
30 required
ErrorResponse500
object
2 properties
2 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed
ClientErrorEnum
string
clienterror - Client Error
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Weblate 12
Other APIs Weblate publishes across the network.
Weblate addons API
Weblate categories API
Weblate changes API
Weblate component-lists API
Weblate contributions API
Weblate groups API
Weblate hooks API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API
Weblate roles API
#components