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

Submit structured query

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope api.everything_else
POST/v1/query/submit/structured
Authorization
AuthorizationBearer token · headerrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
content_modeQueryContentMode

Hint to query APIs on whether to return Roboto entities with custom metadata.

In RecordOnly mode, Roboto entities are returned without custom metadata, ensuring a smaller and more predictable response size. Use this mode when you need lower query latency, larger result page sizes, or both.

In RecordWithMeta mode, Roboto entities are returned with all available custom metadata. Use this mode if you need immediate access to metadata fields.

Note: content mode support is initially available for dataset queries, and will be added incrementally for other entity types.

Allowed:record_onlyrecord_with_meta
queryQuerySpecificationrequired

Model for specifying a query to the Roboto Platform.

Examples: Specify a query with a single condition: >>> from roboto import query >>> query_spec = query.QuerySpecification( ... condition=query.Condition(field="name", comparator=query.Comparator.Equals, value="Roboto") ... )

Specify a query with multiple conditions:
    >>> from roboto import query
    >>> query_spec = query.QuerySpecification(
    ...     condition=query.ConditionGroup(
    ...         operator=query.ConditionOperator.And,
    ...         conditions=[
    ...             query.Condition(field="name", comparator=query.Comparator.Equals, value="Roboto"),
    ...             query.Condition(field="age", comparator=query.Comparator.GreaterThan, value=18),
    ...         ],
    ...     )
    ... )

Arbitrarily nest condition groups:
    >>> from roboto import query
    >>> query_spec = query.QuerySpecification(
    ...     condition=query.ConditionGroup(
    ...         operator=query.ConditionOperator.And,
    ...         conditions=[
    ...             query.Condition(field="name", comparator=query.Comparator.Equals, value="Roboto"),
    ...             query.ConditionGroup(
    ...                 operator=query.ConditionOperator.Or,
    ...                 conditions=[
    ...                     query.Condition(field="age", comparator=query.Comparator.GreaterThan, value=18),
    ...                     query.Condition(field="age", comparator=query.Comparator.LessThan, value=30),
    ...                 ],
    ...             ),
    ...         ],
    ...     )
    ... )
Show properties
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
targetQueryTargetrequired

The type of resource a specific query is requesting.

Allowed:collectionsdatasetsdevicesfilessessionstopicstopic_message_pathsevents
Responses
201

CREATED

dataobjectrequired

A wire-transmissible representation of a query.

Show properties
modifiedstring<date-time>required

The last time the database record for a query was modified.

org_idstringrequired

The org on behalf of whom a query was run.

query_idstringrequired

Unique identifier for an individual query.

query_ctxQueryContextrequired

Context for a query

Show properties
query_schemeQuerySchemerequired

A specific query format/schema which can be used in combination with some context JSON to provide all information required to execute a query.

Allowed:query_spec_v1
queryobject
result_countinteger

The number of records matched by this query. Defaults to 0 for incomplete queries.

default: 0
statusQueryStatusrequired

The query lifecycle state of a given query.

Allowed:failedresults_availablescheduled
submittedstring<date-time>required

The time at which this query was first created.

submitted_bystringrequired

The user who scheduled this query.

targetQueryTargetrequired

The type of resource a specific query is requesting.

Allowed:collectionsdatasetsdevicesfilessessionstopicstopic_message_pathsevents
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/query/submit/structured' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "content_mode": "record_only",
  "query": {
    "condition": null,
    "limit": 1000,
    "max_results": null,
    "after": null,
    "sort_by": null,
    "sort_direction": null
  },
  "target": "collections"
}'
Response
{
  "data": {
    "modified": "2019-08-24T14:15:22Z",
    "org_id": "string",
    "query_id": "string",
    "query_ctx": {
      "query_scheme": "query_spec_v1",
      "query": {}
    },
    "result_count": 0,
    "status": "failed",
    "submitted": "2019-08-24T14:15:22Z",
    "submitted_by": "string",
    "target": "collections"
  }
}