Runs the at-rest discovery scan over one KB's stored documents: classify every chunk's (redacted) text, label each document, count redaction markers, append the scan evidence row.
POST
/v1/m/knowledge/kbs/{id}/scan
const url = 'https://example.com/v1/m/knowledge/kbs/example/scan';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/m/knowledge/kbs/example/scan \ --header 'Authorization: Bearer <token>'Runs the at-rest discovery scan over one KB’s stored documents: classify every chunk’s (redacted) text, label each document, count redaction markers, append the scan evidence row.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Path parameter id.
Header Parameters
Section titled “Header Parameters ” X-Olivares-Tenant
string format: uuid
Target tenant id; required when the principal can act in more than one tenant.
Responses
Section titled “ Responses ”OK
Media type application/json
object
Example generated
{}Bad request
Media type application/json
object
Example generated
{}Unauthenticated
Media type application/json
object
Example generated
{}Forbidden
Media type application/json
object
Example generated
{}Not found
Media type application/json
object
Example generated
{}Conflict / setup required
Media type application/json
object
Example generated
{}Rate limited
Media type application/json
object
Example generated
{}