Skip to content
localisyncDocs
Open panel

Start a discussion with an optional language scope

Requires current workspace membership. Manager-only operations include permission and project-link management. Text approval requires a separate language review grant; resource editor access never grants translation permissions. Expected versions and branch scope are checked before mutation. Source and context text are not telemetry.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/keys/{keyId}/discussions

Operation: createDiscussion · Download OpenAPI

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
"type": "apiKey",
"in": "cookie",
"name": "localisync_session"
}
Name Location Required Description
workspaceId path Yes See constraints below.
projectId path Yes See constraints below.
branchId path Yes See constraints below.
keyId path Yes See constraints below.
Origin header Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
Idempotency-Key header Yes See constraints below.
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uri"
}
{
"type": "string"
}
{
"type": "string",
"format": "uuid"
}

Required: Yes.

Schema reference: DiscussionInput.

Field Type Required Constraints / description
text string Yes minLength: 1
mentions Array of string Yes maxItems: 20
locale See schema Yes —
{
"$ref": "#/components/schemas/DiscussionInput"
}

Result returned.

Content type: application/json Schema reference: DiscussionThread.

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)$"
locale See schema Yes —
authorId 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)$"
resolved boolean Yes —
version integer Yes maximum: 2147483646
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))$"
canResolve boolean Yes —
{
"$ref": "#/components/schemas/DiscussionThread"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting

Cookie preferences

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