Learning progress (last 24h)

GET

/v1/workspaces/{workspaceId}/knowledge/status

const url = 'https://shareout.site/v1/workspaces/example/knowledge/status';
const options = {method: 'GET', 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 GET \
  --url https://shareout.site/v1/workspaces/example/knowledge/status \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Responses

200

Progress

application/json

object

enabled

boolean

queued

integer

processed

integer

total

integer

running

boolean

lastProcessedAt

string | null

corpus

Per-source corpus status (null when the corpus is not configured). Owners, admins and instance admins see every source; members only sources they may open.

object

chunker_version

Current chunker; sources with a lower one are re-learned overnight.

integer

last_reindex_at

string | null

counts

object

queued

integer

ready

integer

failed

integer

unsupported

integer

sources

Array<object>

object

string

kind

string

Allowed values: page asset

title

string

status

string

Allowed values: queued ready failed unsupported

version

Version (page) or blob (File) indexed

string

chunker_version

integer

outdated

boolean

chunks

integer

chunks_with_page

Chunks on a sub-page of a multi-page site

integer

chunks_with_anchor

Chunks that deep-link to a section heading

integer

error

string | null

updated_at

string

Example

{
  "corpus": {
    "sources": [
      {
        "kind": "page",
        "status": "queued"
      }
    ]
  }
}

403

Access denied

application/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"
    ]
  }
}