Skip to content

Search Workspace Documents

POST
/search/workspace

Search Studio’s documents, intelligence and research.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
filters
Any of:
object
key
additional properties
any
k

How many results.

integer
default: 20
query
required
string
search_type

auto picks keyword or semantic from the wording of the query.

string
default: auto
Allowed values: semantic exact hybrid auto

Responses

200

Successful Response

object
data
required

Search results, grouped the way the app groups them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string