Skip to content
Olivares AI docs

Federated console search: fan out to every searchable kind, deny-closed per kind on its own read permission

GET
/v1/search
 
curl --request GET \
  --url 'https://example.com/v1/search?q=example' \
  --header 'Authorization: Bearer <token>'

Fans one query out across every searchable kind and returns the matches. Each kind is gated on its own read permission, so the result only narrows what the caller could already list.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Query Parameters

Section titled “ Query Parameters ”
q
required
string
<= 100 characters

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
degraded
required
boolean
degraded_kinds
required
Array<string>
results
required
Array<object>
object
detail

Short non-sensitive annotation (status/kind); never config or spec content

string
id
required
string
kind
required

Result kind tag (e.g. workspace, user, connector, governance.policy, eventing.subscription, notify.route, orchestration.schedule)

string
name
required
string
truncated
required
boolean
Example generated 
{
  "degraded": true,
  "degraded_kinds": [
    "example"
  ],
  "results": [
    {
      "detail": "example",
      "id": "example",
      "kind": "example",
      "name": "example"
    }
  ],
  "truncated": true
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}