Resources
Search resources (lightweight)
GET
/resources/searchAuthorization
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
Query Parameters
q?string
Free-text query.
type?integer
Restrict to a specific resource type.
limit?integer
Range
value <= 100Default
20offset?integer
Default
0mode?string
Search mode. keyword (default) is the existing behaviour and its
response shape is unchanged. vector runs semantic search over the
vectors index; hybrid runs both and merges to resource level. When
mode is absent the operation behaves exactly as before. For
vector/hybrid the response data is ModedSearchResponse.
Default
"keyword"Value in
- "keyword"
- "vector"
- "hybrid"
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/resources/search"{ "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": "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." }}