Search the workspace's Files and pages

GET

/v1/workspaces/{workspaceId}/knowledge/search

const url = 'https://shareout.site/v1/workspaces/example/knowledge/search?q=example&format=md';
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/search?q=example&format=md' \
  --header 'Authorization: Bearer <token>'

Cited passages. 409 KNOWLEDGE_DISABLED when off; 501 when the instance has no search index.

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Query Parameters

required

string

limit

integer

format

string

Allowed values: md

md returns text/markdown.

Responses

200

{ query, ... } results

400

Invalid request

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

409

Knowledge is off (KNOWLEDGE_DISABLED)