Skip to content
ShareOutShareOut Docs

Palette deep search

GET
/v1/home/deep-search
curl --request GET \
  --url 'https://shareout.site/v1/home/deep-search?q=example&older=1&limit=5' \
  --header 'Authorization: Bearer <token>'

What the local index cannot answer: pages whose description matches (content), Knowledge passages when the workspace has Knowledge (passages), and the datasets, connectors, schedules, crew, alerts and skills groups. Same visibility as /v1/search.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required
string

Search text; under 2 characters returns empty groups, passages need 3.

workspace
string
older
string
Allowed values: 1

Also match names of pages past the index cap (send when the index was truncated).

limit
integer
default: 5 <= 20

Max results per group.

Responses

Section titled “Responses”

200

Section titled “200”

Grouped hits

Media typeapplication/json
object
query
string
content
Array<object>
object
passages

{ artifact: { id, title }, page, page_title, section, excerpt, url }

Array<object>
object
datasets
Array<object>
object
connectors
Array<object>
object
schedules
Array<object>
object
crew
Array<object>
object
alerts
Array<object>
object
skills
Array<object>
object
Examplegenerated
{
  "query": "example",
  "content": [
    {}
  ],
  "passages": [
    {}
  ],
  "datasets": [
    {}
  ],
  "connectors": [
    {}
  ],
  "schedules": [
    {}
  ],
  "crew": [
    {}
  ],
  "alerts": [
    {}
  ],
  "skills": [
    {}
  ]
}

401

Section titled “401”

Authentication required

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