Select frozen context before approving generation

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.

PATCH /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/translation-assistance/jobs/{id}/suggestions/{itemId}/context

Operation: selectTranslationProviderContext · Download OpenAPI

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

Name	Location	Required	Description
`workspaceId`	path	Yes	See constraints below.
`projectId`	path	Yes	See constraints below.
`branchId`	path	Yes	See constraints below.
`id`	path	Yes	See constraints below.
`itemId`	path	Yes	See constraints below.
`X-CSRF-Token`	header	Yes	See constraints below.
`Origin`	header	Yes	See constraints below.

workspaceId

{
  "type": "string",
  "format": "uuid"
}

projectId

{
  "type": "string",
  "format": "uuid"
}

branchId

{
  "type": "string",
  "format": "uuid"
}

id

{
  "type": "string",
  "format": "uuid"
}

itemId

{
  "type": "string",
  "format": "uuid"
}

X-CSRF-Token

{
  "type": "string"
}

Origin

{
  "type": "string"
}

Request body

Required: Yes.

application/json

Schema reference: ContextSelection.

Field	Type	Required	Constraints / description
`version`	integer	Yes	maximum: `9007199254740991`
`selected`	Array of string	Yes	maxItems: `161`

{
  "$ref": "#/components/schemas/ContextSelection"
}

Responses

200

Operation confirmed. Generation is asynchronous; proposals do not change translations until explicit Apply.

Content type: application/json Schema reference: Job.

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))$"`

{
  "$ref": "#/components/schemas/Job"
}