How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weblate components API

The components API from Weblate — 17 operation(s) for components.

Weblate components API is one of 22 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.2.0.

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.

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

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.
api_components_list 2 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/
Return information about translation component.
api_components_retrieve 2 params → 400401403404405406423429
PUT
/api/components/{project__slug}/{slug}/
Edit a component by a PUT or PATCH request.
api_components_update 2 params body → 400401403404405406415423
PATCH
/api/components/{project__slug}/{slug}/
Edit a component by a PATCH request.
api_components_partial_update 2 params body → 400401403404405406415423
DELETE
/api/components/{project__slug}/{slug}/
Delete a component.
api_components_destroy 2 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/addons/
Translation components API.
api_components_addons_create 2 params body → 400401403404405406415423
GET
/api/components/{project__slug}/{slug}/announcements/
Return announcements.
api_components_announcements_list 4 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/announcements/
Create an announcement.
api_components_announcements_create 2 params body → 400401403404405406415423
DELETE
/api/components/{project__slug}/{slug}/announcements/{announcement_id}/
Delete an announcement.
api_components_announcements_destroy 3 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/changes/
Return a list of component changes.
api_components_changes_list 4 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/credits/
Translation components API.
api_components_credits_retrieve 2 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/file/
Download all translation files in the component.
api_components_file_retrieve 2 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/links/
Return projects linked with a component.
api_components_links_list 4 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/links/
Associate project with a component.
api_components_links_create 2 params body → 400401403404405406415423
DELETE
/api/components/{project__slug}/{slug}/links/{project_slug}/
Remove association of a project with a component.
api_components_links_destroy 3 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/lock/
Return component lock status.
api_components_lock_retrieve 2 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/lock/
Sets component lock status.
api_components_lock_create 2 params body → 400401403404405406415423
GET
/api/components/{project__slug}/{slug}/monolingual_base/
Download base file for monolingual translations.
api_components_monolingual_base_retrieve 2 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/new_template/
Download template file for new translations.
api_components_new_template_retrieve 2 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/repository/
Return information about VCS repository status.
api_components_repository_retrieve 2 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/repository/
Perform given operation on the VCS repository.
api_components_repository_create 2 params body → 400401403404405406415423
GET
/api/components/{project__slug}/{slug}/screenshots/
Return a list of component screenshots.
api_components_screenshots_list 4 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/statistics/
Return paginated statistics for all translations within component.
api_components_statistics_list 4 params → 400401403404405406423429
GET
/api/components/{project__slug}/{slug}/translations/
Return a list of translation objects in the given component.
api_components_translations_list 4 params → 400401403404405406423429
POST
/api/components/{project__slug}/{slug}/translations/
Create a new translation in the given component.
api_components_translations_create 2 params body → 400401403404405406415423

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.

NewLangEnum
string
contact - Contact maintainers url - Point to translation instructions URL add - Create new language file none - Disable adding new translations
PriorityEnum
integer
60 - Very high 80 - High 100 - Medium 120 - Low 140 - Very low
ServerErrorEnum
string
servererror - Server Error
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…
Project
object
61 properties 30 required
PaginatedAnnouncementList
object
4 properties 2 required
Error500
object
3 properties 3 required
PaginatedProjectList
object
4 properties 2 required
ErrorCode415Enum
string
unsupportedmediatype - Unsupported Media Type
PaginatedChangeList
object
4 properties 2 required
ErrorCode401Enum
string
authenticationfailed - Authentication Failed notauthenticated - Not Authenticated
DirectionEnum
string
- Automatically detect text direction ltr - Left to right rtl - Right to left
Language
object
10 properties 6 required
Repository
object
Serializer for repository status information.
11 properties 4 required
ErrorResponse404
object
2 properties 2 required
Change
object
13 properties 9 required
ErrorResponse500
object
2 properties 2 required
Screenshot
object
7 properties 6 required
Statistics
object
37 properties 33 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
ErrorResponse403
object
2 properties 2 required
CommitInfo
object
Detailed information about a Git commit.
12 properties
ComponentLinkRequest
object
2 properties 1 required
ErrorResponse429
object
2 properties 2 required
ErrorCode406Enum
string
notacceptable - Not Acceptable
PendingUnits
object
Detailed breakdown of pending translation units.
4 properties 4 required
ErrorCode403Enum
string
permissiondenied - Permission Denied
LockRequest
object
1 property 1 required
Error429
object
3 properties 3 required
Error415
object
3 properties 3 required
Component
object
93 properties 34 required
Error406
object
3 properties 3 required
ComponentLinkResponse
object
1 property 1 required
PatchedComponent
object
93 properties
ErrorCode500Enum
string
error - Error
ErrorResponse423
object
2 properties 2 required
BlankEnum
ActionEnum
integer
0 - Resource updated 1 - Translation completed 2 - Translation changed 3 - Comment added 4 - Suggestion added 5 - Translation added 6 - Automatically translate…
ComponentTranslation
object
32 properties 30 required
VcsEnum
string
gerrit - Gerrit git - Git git-force-push - Git with force push local - No remote repository mercurial - Mercurial subversion - Subversion
SeverityEnum
string
info - Info (light blue) warning - Warning (yellow) danger - Danger (red) success - Success (green)
PaginatedScreenshotList
object
4 properties 2 required
Error405
object
3 properties 3 required
RepositoryOperation
object
2 properties 1 required
PaginatedComponentList
object
4 properties 2 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…
ErrorCode429Enum
string
throttled - Throttled
ErrorResponse406
object
2 properties 2 required
ErrorCode404Enum
string
notfound - Not Found
CommitPolicyEnum
integer
0 - Commit all translations regardless of quality 20 - Skip translations marked as needing editing 30 - Only include approved translations
Error400
object
3 properties 3 required
ComponentTranslationResponse
object
1 property 1 required
LanguagePlural
object
5 properties 2 required
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
MergeStyleEnum
string
merge - Merge rebase - Rebase mergenoff - Merge without fast-forward
Announcement
object
5 properties 2 required
Error423
object
3 properties 3 required
PaginatedComponentTranslationList
object
4 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…
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…
PaginatedStatisticsList
object
4 properties 2 required
ErrorResponse415
object
2 properties 2 required
ClientErrorEnum
string
clienterror - Client Error
ErrorResponse400
object
2 properties 2 required
ErrorResponse405
object
2 properties 2 required
RepoRequest
object
1 property 1 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…
Error404
object
3 properties 3 required
Lock
object
1 property
Error401
object
3 properties 3 required
ErrorResponse401
object
2 properties 2 required
TranslationCreate
object
2 properties 1 required
Error403
object
3 properties 3 required
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weblate-components-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 contributions API
Weblate groups API
Weblate hooks API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API
Weblate roles API
Where this information came from

This is an independent, third-party profile of Weblate components API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.