Search resources (advanced)

POST/resources/search

Full-shape search. The body lets you combine free text with per-field, per-node, and date-range filters; pick a sort order; and paginate. fieldFilters and dateFilters are keyed by field name as returned by GET /resources/fields, and the available field names are instance-specific (they differ per publisher/deployment) — call GET /resources/fields first to learn what you can filter on for the tenant you are connected to. See GET /resources/fields/{id}/options for tree options.

Authorization

apiKey

X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body for POST /resources/search. All fields are optional; an empty body returns the first page of every resource the api-key can see.

mode?string

Search mode. keyword (default) preserves the existing keyword behaviour and response shape. vector runs semantic vector search; hybrid merges keyword + vector to resource level, deduping on ref. May also be supplied as the mode query parameter; the body value wins. For vector/hybrid the response data is ModedSearchResponse, not the keyword-mode SearchResponse.

Default"keyword"

Value in

"keyword"
"vector"
"hybrid"

query?string

Free-text query.

resourceTypes?array<integer>

Restrict to these resource-type ids (see /resources/types).

fieldFilters?

Per-field equality filters keyed by field name (see /resources/fields for the names). Values are strings. The available field names are instance-specific — they differ per publisher/deployment — so discover them at runtime via /resources/fields rather than assuming a fixed set.

nodeFilters?array<integer>

Tree/category node ids to include.

nodeFiltersNot?array<integer>

Tree/category node ids to exclude.

dateFilters?

Date-range filters keyed by field name (see /resources/fields). As with fieldFilters, the available field names are instance-specific, so discover them at runtime.

archiveStates?array<integer>

Archive states to include. Defaults to [0, 1].

orderBy?string

Default"relevance"

Value in

"relevance"
"date"
"title"
"resourceid"
"resourcetype"
"popularity"
"rating"

sort?string

Default"desc"

Value in

"asc"
"desc"

limit?integer

Capped at 100 on this endpoint.

Rangevalue <= 100

Default48

offset?integer

Default0

collectionId?integer

Restrict the search to a specific collection.

privacyFilter?|

private returns only the api-key's own private items; shared returns only shared items; null/omitted returns both.

Value in

"private"
"shared"
null

Response Body

`application/json`

curl -X POST "https://example.com/resources/search" \  -H "Content-Type: application/json" \  -d '{    "query": "watercolour",    "limit": 10  }'

{  "data": {    "results": [      {        "ref": 0,        "title": "string",        "resourceType": 0,        "resourceTypeName": "string",        "fileExtension": "string",        "thumbnailUrl": "string",        "previewUrl": "string",        "createdDate": "string",        "modifiedDate": "string",        "archive": 0,        "score": 0,        "isPrivate": true,        "fields": {}      }    ],    "total": 0,    "limit": 0,    "offset": 0  }}

{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "Hourly rate limit exceeded.",  "error": {    "code": "RATE_LIMITED",    "message": "Hourly rate limit exceeded."  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

Example noApiKey

Example invalidApiKey

Example linkedUserRequired

`application/json`

`application/json`

`application/json`

`application/json`