Skip to content

Re-learn the corpus, even at unchanged versions

POST
/v1/workspaces/{workspaceId}/knowledge/reindex
curl --request POST \
--url https://shareout.site/v1/workspaces/example/knowledge/reindex \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "artifactIds": [ "example" ] }'

Owner/admin of the workspace, or an instance admin. Re-chunks every live, non-held page and File (or only artifactIds) with the current chunker, through the normal ingest path (metered the same way). Once per workspace per 10 minutes; at most 300 sources per call (remaining says how many are left).

workspaceId
required
string

Workspace ID or slug.

Media typeapplication/json
object
artifactIds
Array<string>
>= 1 items <= 300 items
Examplegenerated
{
"artifactIds": [
"example"
]
}

Queued

Media typeapplication/json
object
queued
integer
remaining
integer
skipped

Requested ids that are not live, eligible sources of this workspace

Array<string>
Examplegenerated
{
"queued": 1,
"remaining": 1,
"skipped": [
"example"
]
}

Bad body (VALIDATION_ERROR)

Access denied

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}

Knowledge is off (KNOWLEDGE_DISABLED)

Rate limit reached (RATE_LIMIT_EXCEEDED on publish / account creation / AI routes, RATE_LIMITED on the data plane). Wait for Retry-After / reset.

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}