Validate and connect one existing documentation repository

PUT/api/v1/workspaces/{workspace_id}/knowledge-repository

Requires explicit acknowledgement that every repository reader can read all mirrored Documents. The configured branch must already exist. No repository, branch, or pull request is created.

Path Parameters

workspace_idRequired

string <uuid>

Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired

string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json

installation_idRequired

string <uuid>

Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.

Example0198ac5e-f9b7-7000-8000-000000000001

resource_idRequired

string <uuid>

Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.

Example0198ac5e-f9b7-7000-8000-000000000001

providerRequired

string

Values

githubgitlabbitbucket

repository_nameRequired

string·min 1·max 300

branchRequired

string·min 1·max 200

docs_rootRequired

string·min 1·max 500

sync_modeRequired

string

Values

outboundbidirectional

repository_readers_acknowledgedRequired

boolean

Must be true to acknowledge that repository readers can read every synchronized Document.

Responses

Authentication · Conventions and errors · API guides · Resource reference

Validate and connect one existing documentation repository