Resources

Tree/category field options

GET/resources/fields/{id}/options

For tree- or list-typed fields, returns the available node options.

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

Path Parameters

id*integer

Response Body

application/json

curl -X GET "https://example.com/resources/fields/0/options"
{  "success": true,  "status": "success",  "message": "Success",  "data": {}}

Create a resource POST

Creates a metadata-only resource of the named type, optionally setting field values in the same call. Requires the `write` scope. ### Names, not refs `type` is a resource type NAME (see `GET /resources/types`); field keys are field names as returned by `GET /resources/fields?type={ref}` (the `name` key; field titles are accepted as a case-insensitive fallback). Type and field refs differ per server — always address by name. Unknown names return 400 with the offending name in the message (`UNKNOWN_TYPE` / `UNKNOWN_FIELD`). ### Values Field values are strings, numbers, booleans, or null (null clears the field). For list-type fields (dropdowns, checkboxes, category trees) pass the option NAMES — either comma-separated in one string or as a JSON array of strings. Options that don't exist are reported per-field in `fieldErrors` without failing the create. The resource is created under the linked user with the same archive state, usergroup scoping, and permission walls as an in-app upload. The title field participates in the same denormalised title handling as internal edits. ### Idempotency Pass an `Idempotency-Key` header (a unique random string per logical create, e.g. a UUID) to make retries safe. The first successful response with a given key is cached for 24 hours; replays return the same body byte-for-byte with `Idempotent-Replayed: true`. Reusing the key with a different request body returns 422 `IDEMPOTENCY_KEY_CONFLICT`.

List searchable fields GET

Returns the searchable fields for **this instance**, resolved live from the box's `resource_type_field` configuration. The field set is **instance-specific** — each publisher/deployment exposes different fields — so an integration should discover fields at runtime rather than assume a fixed set. The `name` of each field is what you pass as a key in `fieldFilters`/`dateFilters` on `POST /resources/search`.