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

List default ingestion rules

The default rules, each saying whether the caller’s org already has it.

Access control

  • requires_org
  • Restricted tokens need the API scope api.everything_else
GET/v1/ingestion-rules/defaults
Authorization
AuthorizationBearer token · headerrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Responses
200

OK

dataobjectrequired

The rules every new org starts with, as GET /v1/ingestion-rules/defaults lists them.

Show properties
itemsDefaultIngestionRuleRecord[]required
Show properties
Array of DefaultIngestionRuleRecord
namestringrequired
include_patternsstring[]required
exclude_patternsstring[]
invocationActionInvocationSpecrequired

How to run an action: which action, its parameters, overrides, and input selectors.

The part of an invoke-action target that says nothing about when it runs, shared by :class:InvokeActionTarget and anything else that stores an action invocation to run later, such as an ingestion rule. String leaves of :attr:parameter_values and :attr:invocation_input may contain {{...}} placeholders resolved against the event namespace at dispatch time.

Show properties
actionActionReferencerequired

Qualified action reference.

Show properties
namestringrequired
digeststring | null
default: null
Show properties
Any of:
string
string
null
null
ownerstring | null
default: null
Show properties
Any of:
string
string
null
null
invocation_inputInvocationInput | 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
FileSelector
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
DataSelector
null
null
topicsDataSelector | DataSelector[] | null
default: null
Show properties
Any of:
DataSelector
DataSelector
DataSelector[]
Array of DataSelector
DataSelector
null
null
null
null
parameter_valuesobject
compute_requirement_overridesComputeRequirements | null
default: null
Show properties
Any of:
ComputeRequirements
vCPUinteger
default: 512
memory_MiBinteger
default: 1024
gpuboolean
default: false
storage_GiBinteger
default: 21
null
null
container_parameter_overridesContainerParameters | null
default: null
Show properties
Any of:
ContainerParameters
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
null
null
timeoutinteger | null
default: null
Show properties
Any of:
integer
integer
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
already_presentbooleanrequired
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
Request
curl -X GET 'https://api.roboto.ai/v1/ingestion-rules/defaults' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": {
    "items": [
      {
        "name": "string",
        "include_patterns": [
          "string"
        ],
        "exclude_patterns": [
          "string"
        ],
        "invocation": {
          "action": {
            "name": "string",
            "digest": null,
            "owner": null
          },
          "invocation_input": null,
          "parameter_values": {},
          "compute_requirement_overrides": null,
          "container_parameter_overrides": null,
          "timeout": null,
          "upload_destination": null
        },
        "already_present": true
      }
    ]
  }
}