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

Query invocations

Access control

  • requires_resource_owner_or_admin
  • Restricted tokens need the API scope api.everything_else
POST/v1/actions/invocations/query
Authorization
AuthorizationBearer token · headerrequired
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
itemsInvocationRecord[]required
Show properties
Array of InvocationRecord
createdstring<date-time>required
data_sourceInvocationDataSourcerequired

Abstracted data source that can be provided to an invocation.

Represents a source of input data for action invocations. The data source type determines how the ID should be interpreted (e.g., as a dataset ID).

Show properties
data_source_typeInvocationDataSourceTyperequired

Source of data for an action's input binding.

Defines the type of data source that provides input data to an action invocation. Currently supports datasets, with potential for future expansion to other data source types.

Allowed:Dataset
data_source_idstringrequired
input_datastring[]required
rich_input_dataInvocationInput | null
default: null
Show properties
Any of:
InvocationInput
filesFileSelector | FileSelector[] | null
default: null
Show properties
Any of:
FileSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
pathsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
FileSelector[]
Array of FileSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
pathsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
null
null
sessionsDataSelector | DataSelector[] | null
default: null
Show properties
Any of:
DataSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
DataSelector[]
Array of DataSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
topicsDataSelector | DataSelector[] | null
default: null
Show properties
Any of:
DataSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
DataSelector[]
Array of DataSelector
querystring | null
default: null
Show properties
Any of:
string
string
null
null
idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
namesstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
null
null
upload_destinationInvocationUploadDestination | null
default: null
Show properties
Any of:
InvocationUploadDestination
destination_typeUploadDestinationType

Type of upload destination for invocation outputs.

Defines where files generated by action invocations should be uploaded. Currently supports datasets as the primary destination type.

Allowed:DatasetUnknown
destination_idstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
invocation_idstringrequired
idempotency_idstring | null
default: null
Show properties
Any of:
string
string
null
null
compute_requirementsComputeRequirementsrequired

Compute requirements for an action invocation.

.. _Relevant AWS Fargate documentation: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html#fargate-tasks-size

Show properties
vCPUinteger
default: 512
memory_MiBinteger
default: 1024
gpuboolean
default: false
storage_GiBinteger
default: 21
container_parametersContainerParametersrequired

Container parameters for an action invocation.

Show properties
commandstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
entry_pointstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
env_varsobject | null
default: null
Show properties
Any of:
object
object
null
null
workdirstring | null
default: null
Show properties
Any of:
string
string
null
null
last_heartbeatstring<date-time> | null
default: null
Show properties
Any of:
string<date-time>
string<date-time>
null
null
last_statusInvocationStatusrequired

Invocation status enum

Allowed:012345997998999
org_idstringrequired
parameter_valuesobject
provenanceInvocationProvenancerequired

Provenance information for an invocation

Show properties
actionActionProvenancerequired

Provenance information for an action

Show properties
namestringrequired
org_idstringrequired
digeststring | null
default: null
Show properties
Any of:
string
string
null
null
executableExecutableProvenancerequired

Provenance information for an action executable

Show properties
container_image_uristring | null
default: null
Show properties
Any of:
string
string
null
null
container_image_digeststring | null
default: null
Show properties
Any of:
string
string
null
null
sourceSourceProvenancerequired

Provenance information for an invocation source

Show properties
source_typeInvocationSourcerequired

Method by which an invocation was run

Allowed:TriggerManual
source_idstringrequired
statusInvocationStatusRecord[]
Show properties
Array of InvocationStatusRecord
statusInvocationStatusrequired

Invocation status enum

Allowed:012345997998999
detailstring | null
default: null
Show properties
Any of:
string
string
null
null
timestampstring<date-time>required
durationstring<duration>
timeoutintegerrequired
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/actions/invocations/query' \
  -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": [
      {
        "created": "2019-08-24T14:15:22Z",
        "data_source": {
          "data_source_type": "Dataset",
          "data_source_id": "string"
        },
        "input_data": [
          "string"
        ],
        "rich_input_data": null,
        "upload_destination": null,
        "invocation_id": "string",
        "idempotency_id": null,
        "compute_requirements": {
          "vCPU": 512,
          "memory_MiB": 1024,
          "gpu": false,
          "storage_GiB": 21
        },
        "container_parameters": {
          "command": null,
          "entry_point": null,
          "env_vars": null,
          "workdir": null
        },
        "last_heartbeat": null,
        "last_status": 0,
        "org_id": "string",
        "parameter_values": {},
        "provenance": {
          "action": {
            "name": "string",
            "org_id": "string",
            "digest": null
          },
          "executable": {
            "container_image_uri": null,
            "container_image_digest": null
          },
          "source": {
            "source_type": "Trigger",
            "source_id": "string"
          }
        },
        "status": [
          {
            "status": 0,
            "detail": null,
            "timestamp": "2019-08-24T14:15:22Z"
          }
        ],
        "duration": "string",
        "timeout": 0
      }
    ],
    "next_token": null,
    "total_count": null
  }
}