Read UTC usage and configured limits
Current workspace membership is required. Owner/Admin manage connections and all jobs; Editors can select safe connection metadata and manage their own jobs. Viewers cannot use assistance. Explicit branch scope, Missing-only targets and active languages are enforced. Preview/suggestions expire after 24 hours. Source text is sent only after usage approval; uncertain paid calls require explicit retry approval. UTC counters cover only Localisync use. All responses are no-store.
GET /api/v1/workspaces/{workspaceId}/translation-providers/{id}/usageOperation: getTranslationProviderUsage · Download OpenAPI
Access
Section titled “Access”Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.
sessionCookie
{ "type": "apiKey", "in": "cookie", "name": "__Host-localisync-session"}Parameters
Section titled “Parameters”| Name | Location | Required | Description |
|---|---|---|---|
workspaceId |
path | Yes | See constraints below. |
id |
path | Yes | See constraints below. |
workspaceId
Section titled “workspaceId”{ "type": "string", "format": "uuid"}{ "type": "string", "format": "uuid"}Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”Operation confirmed. Generation is asynchronous; proposals do not change translations until explicit Apply.
Content type: application/json
Schema reference: Usage.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
jobs |
number | Yes | — |
calls |
number | Yes | — |
reserved |
number | Yes | — |
actual |
number | Yes | — |
unknown |
number | Yes | — |
limits |
object | Yes | — |
{ "$ref": "#/components/schemas/Usage"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Stale scope/version, archived content or idempotency conflict. No partial Apply.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Request rejected. Safe reference is provided; provider bodies and credentials are omitted.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Dependency unavailable; usable translations and existing delivery are unaffected.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
details |
Array of object | No | — |
requestId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "$ref": "#/components/schemas/Error"}Related guidance
Section titled “Related guidance”
Choose whether we remember appearance preferences and use Google Analytics on Localisync and its documentation. Optional storage stays off until you accept.
Read our cookie policy