New: AI Insights are here.
See what your users are asking.
⌘Ctrlk
Pricing Log in Sign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Translations

Configure multi-language support and translation options for your documentation.

The Translations API provides ways to localize your content into various languages. It supports custom strings, default language settings, and more.

List all the translations

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/translations
200

OK

Create a translation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Body
languagestring · enumRequiredPossible values:
Responses
post/orgs/{organizationId}/translations

Get a translation by its ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
translationIdstringRequired

The unique id of the translation

Responses
200

OK

application/json
objectstring · enumRequiredPossible values:
idstringRequired

Unique identifier of the translation sync

statusstring · enumRequiredPossible values:
languagestring · enumRequiredPossible values:
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
get/orgs/{organizationId}/translations/{translationId}

Update a translation

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
translationIdstringRequired

The unique id of the translation

Body
Responses
200

Translation has been updated

application/json
objectstring · enumRequiredPossible values:
idstringRequired

Unique identifier of the translation sync

statusstring · enumRequiredPossible values:
languagestring · enumRequiredPossible values:
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
put/orgs/{organizationId}/translations/{translationId}

Delete a translation

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
translationIdstringRequired

The unique id of the translation

Responses
delete/orgs/{organizationId}/translations/{translationId}
No content

Run a translation again

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
translationIdstringRequired

The unique id of the translation

Responses
post/orgs/{organizationId}/translations/{translationId}/run
No content

Last updated

Was this helpful?

AltStyle によって変換されたページ (->オリジナル) /