Create ingestion rule

Access control

requires_org
Restricted tokens need the API scope api.everything_else

POST/v1/ingestion-rules

Authorization

AuthorizationBearer token · headerrequired

Header parameters

X-Roboto-Org-Idstring

X-Roboto-User-Idstring

Request body

requiredapplication/json

namestringrequired

descriptionstring | null

default: null

Show properties

Any of:

string

string

null

null

include_patternsstring[]required

exclude_patternsstring[]

invocationActionInvocationSpec | null

default: null

Show properties

Any of:

ActionInvocationSpec

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

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

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

null

null

auto_ingestboolean

default: true

Responses

201

CREATED

dataobjectrequired

Wire format of an ingestion rule: which file paths in an org are ingestable, and how they are ingested.

A file whose path matches any of :attr:include_patterns and none of :attr:exclude_patterns is marked ingestable when it is created. The rule owns one trigger (:attr:trigger_id) that runs :attr:invocation on each matching upload while :attr:auto_ingest is on.

Show properties

rule_idstringrequired

org_idstringrequired

namestringrequired

descriptionstring | null

default: null

Show properties

Any of:

string

string

null

null

include_patternsstring[]required

exclude_patternsstring[]

invocationActionInvocationSpec | null

default: null

Show properties

Any of:

ActionInvocationSpec

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

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

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

null

null

auto_ingestbooleanrequired

trigger_idstring | null

default: null

Show properties

Any of:

string

string

null

null

createdstring<date-time>required

created_bystringrequired

modifiedstring<date-time>required

modified_bystringrequired

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

X-Roboto-Org-IdheaderX-Roboto-User-Idheader

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.roboto.ai/v1/ingestion-rules' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": null,
  "include_patterns": [
    "string"
  ],
  "exclude_patterns": [
    "string"
  ],
  "invocation": null,
  "auto_ingest": true
}'

const response = await fetch("https://api.roboto.ai/v1/ingestion-rules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": null,\n  \"include_patterns\": [\n    \"string\"\n  ],\n  \"exclude_patterns\": [\n    \"string\"\n  ],\n  \"invocation\": null,\n  \"auto_ingest\": true\n}"
});

import requests

response = requests.post(
    "https://api.roboto.ai/v1/ingestion-rules",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": null,\n  \"include_patterns\": [\n    \"string\"\n  ],\n  \"exclude_patterns\": [\n    \"string\"\n  ],\n  \"invocation\": null,\n  \"auto_ingest\": true\n}",
)

Response

{
  "data": {
    "rule_id": "string",
    "org_id": "string",
    "name": "string",
    "description": null,
    "include_patterns": [
      "string"
    ],
    "exclude_patterns": [
      "string"
    ],
    "invocation": null,
    "auto_ingest": true,
    "trigger_id": null,
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}