Skip to content
localisyncDocs
Open panel

Translation assistance schemas

These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.

Field Type Required Constraints / description
provider openai, gemini, google, deepl Yes —
name string Yes minLength: 1; maxLength: 100; pattern: "^[^\\p{Cc}]+$"
model string No maxLength: 100; default: ""
account See schema No default: null
billingDeclared boolean No default: false
limits object Yes —
id 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)$"
workspaceId 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)$"
enabled boolean Yes —
version integer Yes maximum: 9007199254740991
secretVersion integer Yes maximum: 9007199254740991
createdAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
changedAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
removedAt See schema Yes —
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\p{Cc}]+$"
},
"model": {
"default": "",
"type": "string",
"maxLength": 100
},
"account": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"free",
"pro"
]
},
{
"type": "null"
}
]
},
"billingDeclared": {
"default": false,
"type": "boolean"
},
"limits": {
"type": "object",
"properties": {
"dailyJobs": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"dailyCalls": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"dailyUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"jobUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"outputTokens": {
"type": "integer",
"minimum": 256,
"maximum": 32768
}
},
"required": [
"dailyJobs",
"dailyCalls",
"dailyUnits",
"jobUnits",
"outputTokens"
],
"additionalProperties": false
},
"id": {
"type": "string",
"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)$"
},
"workspaceId": {
"type": "string",
"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)$"
},
"enabled": {
"type": "boolean"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"secretVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"changedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"removedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"name",
"limits",
"id",
"workspaceId",
"enabled",
"version",
"secretVersion",
"createdAt",
"changedAt",
"removedAt"
],
"additionalProperties": false
}
Field Type Required Constraints / description
items Array of object Yes —
page integer Yes maximum: 9007199254740991
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes —
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\p{Cc}]+$"
},
"model": {
"default": "",
"type": "string",
"maxLength": 100
},
"account": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"free",
"pro"
]
},
{
"type": "null"
}
]
},
"billingDeclared": {
"default": false,
"type": "boolean"
},
"limits": {
"type": "object",
"properties": {
"dailyJobs": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"dailyCalls": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"dailyUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"jobUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"outputTokens": {
"type": "integer",
"minimum": 256,
"maximum": 32768
}
},
"required": [
"dailyJobs",
"dailyCalls",
"dailyUnits",
"jobUnits",
"outputTokens"
],
"additionalProperties": false
},
"id": {
"type": "string",
"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)$"
},
"workspaceId": {
"type": "string",
"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)$"
},
"enabled": {
"type": "boolean"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"secretVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"changedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"removedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"name",
"limits",
"id",
"workspaceId",
"enabled",
"version",
"secretVersion",
"createdAt",
"changedAt",
"removedAt"
],
"additionalProperties": false
}
},
"page": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"items",
"page",
"pageSize",
"hasMore"
]
}
Field Type Required Constraints / description
provider openai, gemini, google, deepl Yes —
name string Yes minLength: 1; maxLength: 100; pattern: "^[^\\p{Cc}]+$"
model string No maxLength: 100; default: ""
account See schema No default: null
billingDeclared boolean No default: false
limits object Yes —
credential string Yes Provider credential. Never returned or stored as plaintext. Do not place it in browser storage or logs.; minLength: 8; maxLength: 8000; pattern: "^[\\x21-\\x7e]+$"
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\p{Cc}]+$"
},
"model": {
"default": "",
"type": "string",
"maxLength": 100
},
"account": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"free",
"pro"
]
},
{
"type": "null"
}
]
},
"billingDeclared": {
"default": false,
"type": "boolean"
},
"limits": {
"type": "object",
"properties": {
"dailyJobs": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"dailyCalls": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"dailyUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"jobUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"outputTokens": {
"type": "integer",
"minimum": 256,
"maximum": 32768
}
},
"required": [
"dailyJobs",
"dailyCalls",
"dailyUnits",
"jobUnits",
"outputTokens"
],
"additionalProperties": false
},
"credential": {
"type": "string",
"minLength": 8,
"maxLength": 8000,
"pattern": "^[\\x21-\\x7e]+$",
"writeOnly": true,
"description": "Provider credential. Never returned or stored as plaintext. Do not place it in browser storage or logs."
}
},
"required": [
"provider",
"name",
"limits",
"credential"
],
"additionalProperties": false
}
Field Type Required Constraints / description
provider openai, gemini, google, deepl Yes —
name string Yes minLength: 1; maxLength: 100; pattern: "^[^\\p{Cc}]+$"
model string No maxLength: 100; default: ""
account See schema No default: null
billingDeclared boolean No default: false
limits object Yes —
version integer Yes maximum: 9007199254740991
enabled boolean Yes —
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\p{Cc}]+$"
},
"model": {
"default": "",
"type": "string",
"maxLength": 100
},
"account": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"free",
"pro"
]
},
{
"type": "null"
}
]
},
"billingDeclared": {
"default": false,
"type": "boolean"
},
"limits": {
"type": "object",
"properties": {
"dailyJobs": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"dailyCalls": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"dailyUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"jobUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"outputTokens": {
"type": "integer",
"minimum": 256,
"maximum": 32768
}
},
"required": [
"dailyJobs",
"dailyCalls",
"dailyUnits",
"jobUnits",
"outputTokens"
],
"additionalProperties": false
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"enabled": {
"type": "boolean"
}
},
"required": [
"provider",
"name",
"limits",
"version",
"enabled"
],
"additionalProperties": false
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
credential string Yes Provider credential. Never returned or stored as plaintext. Do not place it in browser storage or logs.; minLength: 8; maxLength: 8000; pattern: "^[\\x21-\\x7e]+$"
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"credential": {
"type": "string",
"minLength": 8,
"maxLength": 8000,
"pattern": "^[\\x21-\\x7e]+$",
"writeOnly": true,
"description": "Provider credential. Never returned or stored as plaintext. Do not place it in browser storage or logs."
}
},
"required": [
"version",
"credential"
],
"additionalProperties": false
}
Field Type Required Constraints / description
jobs number Yes —
calls number Yes —
reserved number Yes —
actual number Yes —
unknown number Yes —
limits object Yes —
{
"type": "object",
"properties": {
"jobs": {
"type": "number"
},
"calls": {
"type": "number"
},
"reserved": {
"type": "number"
},
"actual": {
"type": "number"
},
"unknown": {
"type": "number"
},
"limits": {
"type": "object",
"properties": {
"dailyJobs": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"dailyCalls": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"dailyUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"jobUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000
},
"outputTokens": {
"type": "integer",
"minimum": 256,
"maximum": 32768
}
},
"required": [
"dailyJobs",
"dailyCalls",
"dailyUnits",
"jobUnits",
"outputTokens"
],
"additionalProperties": false
}
},
"required": [
"jobs",
"calls",
"reserved",
"actual",
"unknown",
"limits"
]
}
Field Type Required Constraints / description
connectionId 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)$"
context object No —
sourceLocale string Yes minLength: 1; maxLength: 100
targetLocales Array of string Yes minItems: 1; maxItems: 100
keyIds Array of string No maxItems: 10000
q string No maxLength: 200; default: ""
includeTags Array of string No maxItems: 100; default: []
excludeTags Array of string No maxItems: 100; default: []
timeField key_created, source_changed No —
from string No format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
until string No format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
timeZone string No maxLength: 100; default: "UTC"
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"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)$"
},
"context": {
"type": "object",
"properties": {
"description": {
"default": true,
"type": "boolean"
},
"notes": {
"default": true,
"type": "boolean"
},
"glossary": {
"default": true,
"type": "boolean"
},
"memory": {
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"sourceLocale": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"targetLocales": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"keyIds": {
"maxItems": 10000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"q": {
"default": "",
"type": "string",
"maxLength": 200
},
"includeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"excludeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"timeField": {
"type": "string",
"enum": [
"key_created",
"source_changed"
]
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"default": "UTC",
"type": "string",
"maxLength": 100
}
},
"required": [
"connectionId",
"sourceLocale",
"targetLocales"
],
"additionalProperties": false
}
Field Type Required Constraints / description
id 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)$"
workspaceId 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)$"
projectId See schema Yes —
branchId See schema Yes —
actorId 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)$"
connectionId 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)$"
connectionVersion integer Yes maximum: 9007199254740991
secretVersion integer Yes maximum: 9007199254740991
provider openai, gemini, google, deepl Yes —
model string Yes —
kind test, translation Yes —
state preview, queued, generating, review, partial, outcome_unknown, cancelled, expired, completed, failed, conflict, limited Yes —
version integer Yes maximum: 9007199254740991
sourceLocale string Yes —
options See schema Yes —
summary object Yes —
errorCode string or null Yes —
reservedUnits number Yes —
actualUnits number Yes —
unknownUnits number Yes —
createdAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
expiresAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
{
"type": "object",
"properties": {
"id": {
"type": "string",
"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)$"
},
"workspaceId": {
"type": "string",
"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)$"
},
"projectId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"branchId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"actorId": {
"type": "string",
"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)$"
},
"connectionId": {
"type": "string",
"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)$"
},
"connectionVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"secretVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"model": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"test",
"translation"
]
},
"state": {
"type": "string",
"enum": [
"preview",
"queued",
"generating",
"review",
"partial",
"outcome_unknown",
"cancelled",
"expired",
"completed",
"failed",
"conflict",
"limited"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sourceLocale": {
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"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)$"
},
"context": {
"type": "object",
"properties": {
"description": {
"default": true,
"type": "boolean"
},
"notes": {
"default": true,
"type": "boolean"
},
"glossary": {
"default": true,
"type": "boolean"
},
"memory": {
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"sourceLocale": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"targetLocales": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"keyIds": {
"maxItems": 10000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"q": {
"default": "",
"type": "string",
"maxLength": 200
},
"includeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"excludeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"timeField": {
"type": "string",
"enum": [
"key_created",
"source_changed"
]
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"default": "UTC",
"type": "string",
"maxLength": 100
}
},
"required": [
"connectionId",
"sourceLocale",
"targetLocales"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"summary": {
"type": "object",
"properties": {
"keys": {
"type": "number"
},
"cells": {
"type": "number"
},
"filled": {
"type": "number"
},
"missingSource": {
"type": "number"
},
"unknownDate": {
"type": "number"
},
"incompatible": {
"type": "number"
},
"estimatedUnits": {
"type": "number"
}
},
"required": [
"keys",
"cells",
"filled",
"missingSource",
"unknownDate",
"incompatible",
"estimatedUnits"
]
},
"errorCode": {
"type": [
"string",
"null"
]
},
"reservedUnits": {
"type": "number"
},
"actualUnits": {
"type": "number"
},
"unknownUnits": {
"type": "number"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"id",
"workspaceId",
"projectId",
"branchId",
"actorId",
"connectionId",
"connectionVersion",
"secretVersion",
"provider",
"model",
"kind",
"state",
"version",
"sourceLocale",
"options",
"summary",
"errorCode",
"reservedUnits",
"actualUnits",
"unknownUnits",
"createdAt",
"expiresAt"
]
}
Field Type Required Constraints / description
items Array of object Yes —
page integer Yes maximum: 9007199254740991
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes —
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"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)$"
},
"workspaceId": {
"type": "string",
"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)$"
},
"projectId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"branchId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"actorId": {
"type": "string",
"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)$"
},
"connectionId": {
"type": "string",
"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)$"
},
"connectionVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"secretVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"model": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"test",
"translation"
]
},
"state": {
"type": "string",
"enum": [
"preview",
"queued",
"generating",
"review",
"partial",
"outcome_unknown",
"cancelled",
"expired",
"completed",
"failed",
"conflict",
"limited"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sourceLocale": {
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"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)$"
},
"context": {
"type": "object",
"properties": {
"description": {
"default": true,
"type": "boolean"
},
"notes": {
"default": true,
"type": "boolean"
},
"glossary": {
"default": true,
"type": "boolean"
},
"memory": {
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"sourceLocale": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"targetLocales": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"keyIds": {
"maxItems": 10000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"q": {
"default": "",
"type": "string",
"maxLength": 200
},
"includeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"excludeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"timeField": {
"type": "string",
"enum": [
"key_created",
"source_changed"
]
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"default": "UTC",
"type": "string",
"maxLength": 100
}
},
"required": [
"connectionId",
"sourceLocale",
"targetLocales"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"summary": {
"type": "object",
"properties": {
"keys": {
"type": "number"
},
"cells": {
"type": "number"
},
"filled": {
"type": "number"
},
"missingSource": {
"type": "number"
},
"unknownDate": {
"type": "number"
},
"incompatible": {
"type": "number"
},
"estimatedUnits": {
"type": "number"
}
},
"required": [
"keys",
"cells",
"filled",
"missingSource",
"unknownDate",
"incompatible",
"estimatedUnits"
]
},
"errorCode": {
"type": [
"string",
"null"
]
},
"reservedUnits": {
"type": "number"
},
"actualUnits": {
"type": "number"
},
"unknownUnits": {
"type": "number"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"id",
"workspaceId",
"projectId",
"branchId",
"actorId",
"connectionId",
"connectionVersion",
"secretVersion",
"provider",
"model",
"kind",
"state",
"version",
"sourceLocale",
"options",
"summary",
"errorCode",
"reservedUnits",
"actualUnits",
"unknownUnits",
"createdAt",
"expiresAt"
]
}
},
"page": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"items",
"page",
"pageSize",
"hasMore"
]
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
selected Array of string Yes maxItems: 161
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"selected": {
"maxItems": 161,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 220
}
}
},
"required": [
"version",
"selected"
],
"additionalProperties": false
}
Field Type Required Constraints / description
context Array of object Yes maxItems: 161
id 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)$"
jobId 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)$"
keyId See schema Yes —
definition object Yes —
keyVersion number Yes —
sourceVersion number Yes —
targetVersion number Yes —
source string Yes —
sourceLocale string Yes —
locale string Yes —
suggestion string or null Yes —
state pending, sending, ready, invalid, unknown, applied Yes —
issue string or null Yes —
version integer Yes maximum: 9007199254740991
current See schema No —
{
"type": "object",
"properties": {
"context": {
"maxItems": 161,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 220
},
"kind": {
"type": "string",
"enum": [
"description",
"note",
"glossary",
"memory",
"image"
]
},
"selected": {
"type": "boolean"
},
"text": {
"type": "string",
"maxLength": 1000000
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "string",
"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)$"
},
"size": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 10485760
},
"hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"resolution": {
"type": "string",
"const": "high"
}
},
"required": [
"id",
"size",
"hash",
"width",
"height",
"resolution"
],
"additionalProperties": false
},
"reference": {
"anyOf": [
{
"type": "object",
"properties": {
"entryId": {
"type": "string",
"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)$"
},
"entryVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"resourceId": {
"type": "string",
"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)$"
},
"resourceVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"linksVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entryId",
"entryVersion",
"resourceId",
"resourceVersion",
"linksVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"selected",
"text",
"reference"
],
"additionalProperties": false
}
},
"id": {
"type": "string",
"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)$"
},
"jobId": {
"type": "string",
"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)$"
},
"keyId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"definition": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"plain",
"icu"
]
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"text",
"number"
]
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"name",
"format",
"parameters"
]
},
"keyVersion": {
"type": "number"
},
"sourceVersion": {
"type": "number"
},
"targetVersion": {
"type": "number"
},
"source": {
"type": "string"
},
"sourceLocale": {
"type": "string"
},
"locale": {
"type": "string"
},
"suggestion": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"pending",
"sending",
"ready",
"invalid",
"unknown",
"applied"
]
},
"issue": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"current": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"keyVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
},
"sourceVersion": {
"type": "number"
},
"targetVersion": {
"type": "number"
},
"editable": {
"type": "boolean"
}
},
"required": [
"name",
"keyVersion",
"source",
"target",
"sourceVersion",
"targetVersion",
"editable"
]
},
{
"type": "null"
}
]
}
},
"required": [
"context",
"id",
"jobId",
"keyId",
"definition",
"keyVersion",
"sourceVersion",
"targetVersion",
"source",
"sourceLocale",
"locale",
"suggestion",
"state",
"issue",
"version"
]
}
Field Type Required Constraints / description
items Array of object Yes —
page integer Yes maximum: 9007199254740991
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes —
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"maxItems": 161,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 220
},
"kind": {
"type": "string",
"enum": [
"description",
"note",
"glossary",
"memory",
"image"
]
},
"selected": {
"type": "boolean"
},
"text": {
"type": "string",
"maxLength": 1000000
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "string",
"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)$"
},
"size": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 10485760
},
"hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"resolution": {
"type": "string",
"const": "high"
}
},
"required": [
"id",
"size",
"hash",
"width",
"height",
"resolution"
],
"additionalProperties": false
},
"reference": {
"anyOf": [
{
"type": "object",
"properties": {
"entryId": {
"type": "string",
"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)$"
},
"entryVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"resourceId": {
"type": "string",
"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)$"
},
"resourceVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"linksVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entryId",
"entryVersion",
"resourceId",
"resourceVersion",
"linksVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"selected",
"text",
"reference"
],
"additionalProperties": false
}
},
"id": {
"type": "string",
"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)$"
},
"jobId": {
"type": "string",
"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)$"
},
"keyId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"definition": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"plain",
"icu"
]
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"text",
"number"
]
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"name",
"format",
"parameters"
]
},
"keyVersion": {
"type": "number"
},
"sourceVersion": {
"type": "number"
},
"targetVersion": {
"type": "number"
},
"source": {
"type": "string"
},
"sourceLocale": {
"type": "string"
},
"locale": {
"type": "string"
},
"suggestion": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"pending",
"sending",
"ready",
"invalid",
"unknown",
"applied"
]
},
"issue": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"current": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"keyVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
},
"sourceVersion": {
"type": "number"
},
"targetVersion": {
"type": "number"
},
"editable": {
"type": "boolean"
}
},
"required": [
"name",
"keyVersion",
"source",
"target",
"sourceVersion",
"targetVersion",
"editable"
]
},
{
"type": "null"
}
]
}
},
"required": [
"context",
"id",
"jobId",
"keyId",
"definition",
"keyVersion",
"sourceVersion",
"targetVersion",
"source",
"sourceLocale",
"locale",
"suggestion",
"state",
"issue",
"version"
]
}
},
"page": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"items",
"page",
"pageSize",
"hasMore"
]
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"version"
],
"additionalProperties": false
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
approved boolean Yes —
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"approved": {
"type": "boolean",
"const": true
}
},
"required": [
"version",
"approved"
],
"additionalProperties": false
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
value string Yes maxLength: 16384
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"value": {
"type": "string",
"maxLength": 16384
}
},
"required": [
"version",
"value"
],
"additionalProperties": false
}
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
approved boolean Yes —
ids Array of string No minItems: 1; maxItems: 50000
except Array of string No maxItems: 50000; default: []
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"approved": {
"type": "boolean",
"const": true
},
"ids": {
"minItems": 1,
"maxItems": 50000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"except": {
"default": [],
"maxItems": 50000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
}
},
"required": [
"version",
"approved"
],
"additionalProperties": false
}
Field Type Required Constraints / description
job object Yes —
applied integer Yes maximum: 9007199254740991
{
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"id": {
"type": "string",
"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)$"
},
"workspaceId": {
"type": "string",
"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)$"
},
"projectId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"branchId": {
"anyOf": [
{
"type": "string",
"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)$"
},
{
"type": "null"
}
]
},
"actorId": {
"type": "string",
"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)$"
},
"connectionId": {
"type": "string",
"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)$"
},
"connectionVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"secretVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"model": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"test",
"translation"
]
},
"state": {
"type": "string",
"enum": [
"preview",
"queued",
"generating",
"review",
"partial",
"outcome_unknown",
"cancelled",
"expired",
"completed",
"failed",
"conflict",
"limited"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sourceLocale": {
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"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)$"
},
"context": {
"type": "object",
"properties": {
"description": {
"default": true,
"type": "boolean"
},
"notes": {
"default": true,
"type": "boolean"
},
"glossary": {
"default": true,
"type": "boolean"
},
"memory": {
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"sourceLocale": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"targetLocales": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"keyIds": {
"maxItems": 10000,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"q": {
"default": "",
"type": "string",
"maxLength": 200
},
"includeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"excludeTags": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"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)$"
}
},
"timeField": {
"type": "string",
"enum": [
"key_created",
"source_changed"
]
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"default": "UTC",
"type": "string",
"maxLength": 100
}
},
"required": [
"connectionId",
"sourceLocale",
"targetLocales"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"summary": {
"type": "object",
"properties": {
"keys": {
"type": "number"
},
"cells": {
"type": "number"
},
"filled": {
"type": "number"
},
"missingSource": {
"type": "number"
},
"unknownDate": {
"type": "number"
},
"incompatible": {
"type": "number"
},
"estimatedUnits": {
"type": "number"
}
},
"required": [
"keys",
"cells",
"filled",
"missingSource",
"unknownDate",
"incompatible",
"estimatedUnits"
]
},
"errorCode": {
"type": [
"string",
"null"
]
},
"reservedUnits": {
"type": "number"
},
"actualUnits": {
"type": "number"
},
"unknownUnits": {
"type": "number"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"id",
"workspaceId",
"projectId",
"branchId",
"actorId",
"connectionId",
"connectionVersion",
"secretVersion",
"provider",
"model",
"kind",
"state",
"version",
"sourceLocale",
"options",
"summary",
"errorCode",
"reservedUnits",
"actualUnits",
"unknownUnits",
"createdAt",
"expiresAt"
]
},
"applied": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"job",
"applied"
]
}
Field Type Required Constraints / description
success boolean Yes —
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
]
}
Field Type Required Constraints / description
version string Yes —
providers Array of object Yes —
{
"type": "object",
"properties": {
"version": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"openai",
"gemini",
"google",
"deepl"
]
},
"name": {
"type": "string"
},
"models": {
"type": "array",
"items": {
"type": "string"
}
},
"accounts": {
"type": "array",
"items": {
"type": "string"
}
},
"icu": {
"type": "string"
},
"locales": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"unit": {
"type": "string"
}
},
"required": [
"id",
"name",
"models",
"accounts",
"icu",
"locales",
"unit"
]
}
}
},
"required": [
"version",
"providers"
]
}
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)$"
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"field",
"message"
]
}
},
"requestId": {
"type": "string",
"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)$"
}
},
"required": [
"error",
"message",
"requestId"
]
}

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.