Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Search collections

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope api.everything_else
POST/v1/collections/search
Authorization
AuthorizationBearer token · headerrequired
Query parameters
content_modestring
Allowed:summary_onlyreferencesfull
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
conditionCondition | ConditionGroup | null
default: null
Show properties
Any of:
Condition
fieldstringrequired
comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE
valuestring | boolean | integer | number | string<date-time> | null
default: null
Show properties
Any of:
string
string
boolean
boolean
integer
integer
number
number
string
string
string<date-time>
string<date-time>
null
null
ConditionGroup
operatorConditionOperatorrequired

The operator to use when combining multiple conditions.

Allowed:ANDORNOT
conditionsCondition | ConditionGroup[]required
Show properties
Array of Condition | ConditionGroup
Any of:
Condition
fieldstringrequired
comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE
valuestring | boolean | integer | number | string<date-time> | null
default: null
Show properties
Any of:
string
string
boolean
boolean
integer
integer
number
number
string
string
string<date-time>
string<date-time>
null
null
ConditionGroup
Circular reference to ConditionGroup.
null
null
limitinteger
default: 1000
max_resultsinteger | null
default: null
Show properties
Any of:
integer
integer
null
null
afterstring | null
default: null
Show properties
Any of:
string
string
null
null
sort_bystring | null
default: null
Show properties
Any of:
string
string
null
null
sort_directionSortDirection | null
default: null
Show properties
Any of:
SortDirection
string
null
null
Responses
200

OK

dataobjectrequired
Show properties
itemsCollectionRecord[]required
Show properties
Array of CollectionRecord
collection_idstringrequired
namestring | null
default: null
Show properties
Any of:
string
string
null
null
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
resource_typeCollectionResourceType

Type of resource added to a collection

Allowed:dataseteventfilesession
resourcesobject
missingobject
resource_countinteger
default: 0
tagsstring[]
default: []
custom_fieldsobject
versionintegerrequired
createdstring<date-time>required
created_bystringrequired
updatedstring<date-time>required
updated_bystringrequired
org_idstringrequired
next_tokenstring | null
default: null
Show properties
Any of:
string
string
null
null
total_countinteger | null
default: null
Show properties
Any of:
integer
integer
null
null
400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
401

Thrown when authentication fails

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
403

Thrown if an operation would exceed a user or org level limit.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
410

Thrown if a resource is missing or expired.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
501

Thrown by shimmed out APIs which have not yet been implemented

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.roboto.ai/v1/collections/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "condition": null,
  "limit": 1000,
  "max_results": null,
  "after": null,
  "sort_by": null,
  "sort_direction": null
}'
Response
{
  "data": {
    "items": [
      {
        "collection_id": "string",
        "name": null,
        "description": null,
        "resource_type": "dataset",
        "resources": {
          "property1": [
            null
          ],
          "property2": [
            null
          ]
        },
        "missing": {
          "property1": [
            {
              "resource_type": "dataset",
              "resource_id": "string",
              "resource_version": null
            }
          ],
          "property2": [
            {
              "resource_type": "dataset",
              "resource_id": "string",
              "resource_version": null
            }
          ]
        },
        "resource_count": 0,
        "tags": [],
        "custom_fields": {},
        "version": 0,
        "created": "2019-08-24T14:15:22Z",
        "created_by": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updated_by": "string",
        "org_id": "string"
      }
    ],
    "next_token": null,
    "total_count": null
  }
}