logo
API docs by Redocly

Roboto REST API (1.0.0)

Download OpenAPI specification:Download

Create, read, update, and delete Roboto resources over HTTP. This API is used by both the Roboto web application and the Roboto SDK.

actions

Create, read, and modify entities within Roboto's 'actions' domain

create_action

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
name
required
string (Name)
ComputeRequirements (object) or null
Default: null
ContainerParameters (object) or null
Default: null
Description (string) or Description (null) (Description)
Default: null
ActionReference (object) or null
Default: null
object (Metadata)
Array of objects (Parameters)
Requires Downloaded Inputs (boolean) or Requires Downloaded Inputs (null) (Requires Downloaded Inputs)
Default: null
Short Description (string) or Short Description (null) (Short Description)
Default: null
tags
Array of strings (Tags)
Timeout (integer) or Timeout (null) (Timeout)
Default: null
Uri (string) or Uri (null) (Uri)
Default: null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "compute_requirements": null,
  • "container_parameters": null,
  • "description": null,
  • "inherits": null,
  • "metadata": { },
  • "parameters": [
    ],
  • "requires_downloaded_inputs": null,
  • "short_description": null,
  • "tags": [
    ],
  • "timeout": null,
  • "uri": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_action

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
name
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_action

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
ComputeRequirements (object) or Compute Requirements (null) or Compute Requirements (null) (Compute Requirements)
ContainerParameters (object) or Container Parameters (null) or Container Parameters (null) (Container Parameters)
Description (string) or Description (null) or Description (null) (Description)
ActionReference (object) or Inherits (null) or Inherits (null) (Inherits)
MetadataChangeset (object) or Metadata Changeset (null) (Metadata Changeset)
ActionParameterChangeset (object) or Parameter Changeset (null) (Parameter Changeset)
Uri (string) or Uri (null) or Uri (null) (Uri)
Short Description (string) or Short Description (null) or Short Description (null) (Short Description)
Timeout (integer) or Timeout (null) or Timeout (null) (Timeout)
Requires Downloaded Inputs (boolean) or Requires Downloaded Inputs (null) (Requires Downloaded Inputs)

Responses

Request samples

Content type
application/json
{
  • "compute_requirements": {
    },
  • "container_parameters": {
    },
  • "description": "string",
  • "inherits": {
    },
  • "metadata_changeset": {
    },
  • "parameter_changeset": {
    },
  • "uri": "string",
  • "short_description": "string",
  • "timeout": 0,
  • "requires_downloaded_inputs": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_action

Access control

  • requires_resource_owner_member
  • deny_actions
Authorizations:
http
path Parameters
name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

set_action_accessibility

Access control

  • roboto_admin_only
Authorizations:
http
path Parameters
name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
accessibility
required
string (Accessibility)
Enum: "organization" "action_hub"

Controls who can query for and invoke an action.

Accessibility levels determine the visibility and usability of actions within the Roboto platform. Actions can be private to an organization or published publicly in the Action Hub.

Future accessibility levels may include: "user" and/or "team".

Digest (string) or Digest (null) (Digest)
Default: null

Responses

Request samples

Content type
application/json
{
  • "accessibility": "organization",
  • "digest": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

invoke

Access control

  • requires_org
  • requires_resource_owner
  • deny_actions
Authorizations:
http
path Parameters
name
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
ComputeRequirements (object) or null
Default: null
ContainerParameters (object) or null
Default: null
data_source_id
required
string (Data Source Id)
data_source_type
required
string (InvocationDataSourceType)
Value: "Dataset"

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.

Idempotency Id (string) or Idempotency Id (null) (Idempotency Id)
Default: null
input_data
required
Array of strings (Input Data)
InvocationInput (object) or null
Default: null
invocation_source
required
string (InvocationSource)
Enum: "Trigger" "Manual"

Method by which an invocation was run

Invocation Source Id (string) or Invocation Source Id (null) (Invocation Source Id)
Default: null
Parameter Values (object) or Parameter Values (null) (Parameter Values)
Default: null
Timeout (integer) or Timeout (null) (Timeout)
Default: null
InvocationUploadDestination (object) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "compute_requirement_overrides": null,
  • "container_parameter_overrides": null,
  • "data_source_id": "string",
  • "data_source_type": "Dataset",
  • "idempotency_id": null,
  • "input_data": [
    ],
  • "rich_input_data": null,
  • "invocation_source": "Trigger",
  • "invocation_source_id": null,
  • "parameter_values": null,
  • "timeout": null,
  • "upload_destination": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_distinct_action_tags_for_org

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_distinct_action_tags_for_actionhub

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_invocation_by_id

Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

cancel_invocation

Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

set_invocation_container_info

Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
image_digest
required
string (Image Digest)

Responses

Request samples

Content type
application/json
{
  • "image_digest": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_invocation_ecs_task_info

Authorizations:
http
path Parameters
invocation_id
required
string
query Parameters
required
string or null
required
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

heartbeat_invocation

Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_invocation_ecs_logger_creds

Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

get_invocation_logs

Paginated logs for an invocation that has finished running. To stream logs for an invocation that has not finished running, use the /.../logs/stream endpoint.

Authorizations:
http
path Parameters
invocation_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

set_invocation_logs_location

Access control

  • roboto_admin_only
Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
bucket
required
string (Bucket)
prefix
required
string (Prefix)

Responses

Request samples

Content type
application/json
{
  • "bucket": "string",
  • "prefix": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

stream_invocation_logs

Stream of logs for an invocation that has not finished running.

Authorizations:
http
path Parameters
invocation_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_invocation_status

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
invocation_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
status
required
integer (InvocationStatus)
Enum: 0 1 2 3 4 5 997 998 999

Invocation status enum

detail
required
string (Detail)

Responses

Request samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

batch_cancel_all_active_invocations_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Created Before (string) or Created Before (null) (Created Before)
Default: null

Responses

Request samples

Content type
application/json
{
  • "created_before": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_invocation_stats_for_org

Access control

  • requires_org
Authorizations:
http
query Parameters
start_time
required
string <date-time>

ISO 8601 datetime string

end_time
required
string <date-time>

ISO 8601 datetime string

header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

query_invocations

Access control

  • requires_resource_owner_or_admin
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_scheduling_stats

Access control

  • roboto_admin_only
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_action_metadata_keys_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

query_actions

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

query_actions_on_action_hub

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_action_tags_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

admin

Create, read, and modify entities within Roboto's 'admin' domain

get_migrations

Access control

  • roboto_admin_only
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_per_action_invocation_stats

Access control

  • roboto_admin_only
Authorizations:
http
query Parameters
start_time
number
end_time
number
limit
number
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ai

Create, read, and modify entities within Roboto's 'ai' domain

get_chat_by_id

Authorizations:
http
path Parameters
chat_id
required
string
query Parameters
load_messages
boolean
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_chat_delta

Authorizations:
http
path Parameters
chat_id
required
string
query Parameters
next_token
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

send_message_to_chat

Authorizations:
http
path Parameters
chat_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
role
required
string (ChatRole)
Enum: "user" "assistant" "roboto"

Enumeration of possible roles in a chat conversation.

Defines the different participants that can send messages in a chat session.

required
Array of ChatTextContent (object) or ChatToolUseContent (object) or ChatToolResultContent (object) (Content)
status
string (ChatMessageStatus)
Default: "not_started"
Enum: "not_started" "generating" "completed"

Enumeration of possible message generation states.

Tracks the lifecycle of message generation from initiation to completion.

Responses

Request samples

Content type
application/json
{
  • "role": "user",
  • "content": [
    ],
  • "status": "not_started"
}

Response samples

Content type
application/json
{
  • "data": null
}

collections

Create, read, and modify entities within Roboto's 'collections' domain

get_collection_access

Authorizations:
http
path Parameters
collection_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

edit_collection_access

Authorizations:
http
path Parameters
collection_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Array of objects (Add)
Array of objects (Remove)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_collection

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Description (string) or Description (null) (Description)
Default: null
Name (string) or Name (null) (Name)
Default: null
Array of Resources (objects) or Resources (null) (Resources)
Default: null
Array of Tags (strings) or Tags (null) (Tags)
Default: null

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": null,
  • "resources": null,
  • "tags": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_collection

Authorizations:
http
path Parameters
collection_id
required
string
query Parameters
string or null
content_mode
string
Enum: "summary_only" "references" "full"

Desired content mode for representing a collection

header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_collection

Authorizations:
http
path Parameters
collection_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Array of Add Resources (objects) or Add Resources (null) (Add Resources)
Array of Add Tags (strings) or Add Tags (null) (Add Tags)
Description (string) or Description (null) or Description (null) (Description)
Name (string) or Name (null) or Name (null) (Name)
Array of Remove Resources (objects) or Remove Resources (null) (Remove Resources)
Array of Remove Tags (strings) or Remove Tags (null) (Remove Tags)

Responses

Request samples

Content type
application/json
{
  • "add_resources": [
    ],
  • "add_tags": [
    ],
  • "description": "string",
  • "name": "string",
  • "remove_resources": [
    ],
  • "remove_tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_collection

Authorizations:
http
path Parameters
collection_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_collection_changes

Authorizations:
http
path Parameters
collection_id
required
string
query Parameters
string or null
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

search_collections

Access control

  • requires_resource_owner
Authorizations:
http
query Parameters
content_mode
string
Enum: "summary_only" "references" "full"

Desired content mode for representing a collection

header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_collection_tags_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

comments

Create, read, and modify entities within Roboto's 'comments' domain

create_comment

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
entity_type
required
string (CommentEntityType)
Enum: "action" "collection" "dataset" "file" "invocation" "trigger"

Enumeration of Roboto platform entities that support comments.

This enum defines the types of resources in the Roboto platform that can have comments attached to them. Each value corresponds to a specific domain entity type.

entity_id
required
string (Entity Id)
comment_text
required
string (Comment Text)

Responses

Request samples

Content type
application/json
{
  • "entity_type": "action",
  • "entity_id": "string",
  • "comment_text": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_comment_by_id

Access control

  • requires_org
Authorizations:
http
path Parameters
comment_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_comment

Access control

  • requires_org
Authorizations:
http
path Parameters
comment_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
comment_text
required
string (Comment Text)

Responses

Request samples

Content type
application/json
{
  • "comment_text": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_comment

Access control

  • requires_org
Authorizations:
http
path Parameters
comment_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_comments_for_entity

Access control

  • requires_org
Authorizations:
http
path Parameters
entity_type
required
string
entity_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_recent_comments

Access control

  • requires_org
Authorizations:
http
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_comments_for_entity_type

Access control

  • requires_org
Authorizations:
http
path Parameters
entity_type
required
string
Enum: "action" "collection" "dataset" "file" "invocation" "trigger"

Enumeration of Roboto platform entities that support comments.

This enum defines the types of resources in the Roboto platform that can have comments attached to them. Each value corresponds to a specific domain entity type.

query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_comments_for_user

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
user_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

config

Create, read, and modify entities within Roboto's 'config' domain

get_org_config

Authorizations:
http
path Parameters
org_id
required
string
key
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

set_org_config

Authorizations:
http
path Parameters
org_id
required
string
key
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
value
required
any (Value)

Responses

Request samples

Content type
application/json
{
  • "value": null
}

Response samples

Content type
application/json
{
  • "data": null
}

datasets

Create, read, and modify entities within Roboto's 'datasets' domain

create_dataset

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Description (string) or Description (null) (Description)
Default: null

An optional human-readable description for this dataset.

Device Id (string) or Device Id (null) (Device Id)
Default: null

The ID of the device which created this dataset, if applicable.

Name (string) or Name (null) (Name)
Default: null

A short name for this dataset. Must be under 120 characters or less.

object (Metadata)

Initial key-value pairs to associate with this dataset for discovery and search, e.g. { 'softwareVersion': '3.1.4' }

tags
Array of strings (Tags)

Initial tags to associate with this dataset for discovery and search, e.g. ['sunny', 'campaign5']

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "device_id": null,
  • "name": null,
  • "metadata": { },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_dataset

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_dataset

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
MetadataChangeset (object) or null
Default: null
Description (string) or Description (null) (Description)
Default: null
Device Id (string) or Device Id (null) (Device Id)
Default: null
Name (string) or Name (null) (Name)
Default: null
Array of Conditions (objects) or Conditions (null) (Conditions)
Default: null

Responses

Request samples

Content type
application/json
{
  • "metadata_changeset": null,
  • "description": null,
  • "device_id": null,
  • "name": null,
  • "conditions": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_dataset

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_dataset_access

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

edit_dataset_access

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Array of objects (Add)
Array of objects (Remove)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_directory

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
name
required
string (Name)
error_if_exists
boolean (Error If Exists)
Default: false
Parent Path (string) or Parent Path (null) (Parent Path)
Default: null
Origination (string) or Origination (null) (Origination)
Default: null
create_intermediate_dirs
boolean (Create Intermediate Dirs)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "error_if_exists": false,
  • "parent_path": null,
  • "origination": null,
  • "create_intermediate_dirs": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

rename_directory

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
new_path
required
string (New Path)
old_path
required
string (Old Path)

Responses

Request samples

Content type
application/json
{
  • "new_path": "string",
  • "old_path": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

list_events

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

list_files

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
One of
Array
string

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_directories

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
directory_paths
required
Array of strings (Directory Paths)

Responses

Request samples

Content type
application/json
{
  • "directory_paths": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_directory_child_count

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
directory_path
required
string
show_hidden_files
boolean
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": 0
}

get_directory_contents

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
directory_path
required
string
page_size
number
boolean or null
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

get_directory_file_extensions

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
directory_path
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

query_dataset_files

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Page Token (string) or Page Token (null) (Page Token)
Default: null
Array of Include Patterns (strings) or Include Patterns (null) (Include Patterns)
Default: null
Array of Exclude Patterns (strings) or Exclude Patterns (null) (Exclude Patterns)
Default: null

Responses

Request samples

Content type
application/json
{
  • "page_token": null,
  • "include_patterns": null,
  • "exclude_patterns": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

rename_file

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": null
}

get_dataset_summary

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

generate_dataset_summary

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
One of
Common Knowledge (string) or Common Knowledge (null) (Common Knowledge)
Default: null
System Prompt Override (string) or System Prompt Override (null) (System Prompt Override)
Default: null
User Prompt Guidelines (string) or User Prompt Guidelines (null) (User Prompt Guidelines)
Default: null

Responses

Request samples

Content type
application/json
Example
{
  • "common_knowledge": null,
  • "system_prompt_override": null,
  • "user_prompt_guidelines": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

list_topics

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_dataset_if_not_exists

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
match_roboql_query
required
string (Match Roboql Query)
required
object (CreateDatasetRequest)

Request payload for creating a new dataset.

Used to specify the initial properties of a dataset during creation, including optional metadata, tags, name, and description.

Responses

Request samples

Content type
application/json
{
  • "match_roboql_query": "string",
  • "create_request": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_credentials

Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
mode
string
Enum: "ReadOnly" "ReadWrite"

Enum for permission levels of a Roboto resource. It is a best practice to only request/use the minimum permissions required for a given operation.

For example:

  • When listing files associated with a dataset or pulling a container image hosted in Roboto's registry, use ReadOnly permissions.
  • When adding files to a dataset or pushing a container image to Roboto's registry, use ReadWrite permissions.
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_dataset_metadata_keys_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

query_datasets

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_dataset_tags_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

begin_single_file_upload

Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Origination (string) or Origination (null) (Origination)
Default: null

Additional information about what uploaded the file, e.g. roboto client v1.0.0.

file_path
required
string (File Path)

The destination path to upload the file to in the dataset, e.g. recording.bagor path/to/metadata.json.

file_size
required
integer (File Size)

The size of the file in bytes.

Responses

Request samples

Content type
application/json
{
  • "origination": null,
  • "file_path": "string",
  • "file_size": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

complete_single_file_upload

Authorizations:
http
path Parameters
dataset_id
required
string
upload_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": null
}

devices

Create, read, and modify entities within Roboto's 'devices' domain

create_device

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
device_id
required
string (Device Id)
Org Id (string) or Org Id (null) (Org Id)
Default: null

Responses

Request samples

Content type
application/json
{
  • "device_id": "string",
  • "org_id": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_device_by_id

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
device_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_device_by_id

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
device_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_tokens_for_device

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
device_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create_token_for_device

Access control

  • requires_resource_owner
Authorizations:
http
path Parameters
device_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
expiry_days
required
integer (Expiry Days)

Number of days until the token expires

name
required
string (Name)

A human-readable name for this token.

Description (string) or Description (null) (Description)
Default: null

An optional longer description for this token.

Responses

Request samples

Content type
application/json
{
  • "expiry_days": 0,
  • "name": "string",
  • "description": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_devices_by_org

Authorizations:
http
path Parameters
org_id
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

events

Create, read, and modify entities within Roboto's 'events' domain

create_event

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Array of objects (Associations)
Description (string) or Description (null) (Description)
Default: null
end_time
required
integer (End Time)
object (Metadata)
name
required
string (Name)
start_time
required
integer (Start Time)
tags
Array of strings (Tags)
EventDisplayOptions (object) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "associations": [
    ],
  • "description": null,
  • "end_time": 0,
  • "metadata": { },
  • "name": "string",
  • "start_time": 0,
  • "tags": [
    ],
  • "display_options": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_event_by_id

Authorizations:
http
path Parameters
event_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_event

Authorizations:
http
path Parameters
event_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Description (string) or Description (null) or Description (null) (Description)
MetadataChangeset (object) or Metadata Changeset (null) (Metadata Changeset)
Name (string) or Name (null) (Name)
Start Time (integer) or Start Time (null) (Start Time)
End Time (integer) or End Time (null) (End Time)
EventDisplayOptionsChangeset (object) or Display Options Changeset (null) (Display Options Changeset)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata_changeset": {
    },
  • "name": "string",
  • "start_time": 0,
  • "end_time": 0,
  • "display_options_changeset": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_event

Authorizations:
http
path Parameters
event_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_event_metadata_keys_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

query_events_for_associations

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
Array of objects (Associations)
Page Token (string) or Page Token (null) (Page Token)
Default: null

Responses

Request samples

Content type
application/json
{
  • "associations": [
    ],
  • "page_token": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_event_tags_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

files

Create, read, and modify entities within Roboto's 'files' domain

delete_file

Authorizations:
http
path Parameters
file_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

rename_file

Authorizations:
http
path Parameters
file_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
association_id
required
string (Association Id)
new_path
required
string (New Path)

Responses

Request samples

Content type
application/json
{
  • "association_id": "string",
  • "new_path": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_signed_url

Authorizations:
http
path Parameters
file_id
required
string
query Parameters
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_file_summary

Authorizations:
http
path Parameters
file_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

generate_file_summary

Authorizations:
http
path Parameters
file_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
One of
Common Knowledge (string) or Common Knowledge (null) (Common Knowledge)
Default: null
System Prompt Override (string) or System Prompt Override (null) (System Prompt Override)
Default: null
User Prompt Guidelines (string) or User Prompt Guidelines (null) (User Prompt Guidelines)
Default: null

Responses

Request samples

Content type
application/json
Example
{
  • "common_knowledge": null,
  • "system_prompt_override": null,
  • "user_prompt_guidelines": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_all_records_for_association

Access control

  • roboto_admin_only
Authorizations:
http
path Parameters
association_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list_directories

Authorizations:
http
path Parameters
association_id
required
string
query Parameters
string or null
page_size
number
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

import_one

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
dataset_id
required
string (Dataset Id)
Description (string) or Description (null) (Description)
Default: null
Device Id (string) or Device Id (null) (Device Id)
Default: null
Array of Tags (strings) or Tags (null) (Tags)
Default: null
Metadata (object) or Metadata (null) (Metadata)
Default: null
relative_path
required
string (Relative Path)
Size (integer) or Size (null) (Size)
Default: null
uri
required
string (Uri)

Responses

Request samples

Content type
application/json
{
  • "dataset_id": "string",
  • "description": null,
  • "device_id": null,
  • "tags": null,
  • "metadata": null,
  • "relative_path": "string",
  • "size": null,
  • "uri": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

import_batch

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
Array of objects (Requests)

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_file_metadata_keys_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

query_files

Access control

  • requires_resource_owner_or_admin
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_query_result_count

Access control

  • requires_resource_owner_or_admin
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": 0
}

get_file_record_by_id

Authorizations:
http
path Parameters
file_id
required
string
query Parameters
number or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_file_record

Authorizations:
http
path Parameters
file_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Description (string) or Description (null) or Description (null) (Description)
Device Id (string) or Device Id (null) or Device Id (null) (Device Id)
MetadataChangeset (object) or Metadata Changeset (null) (Metadata Changeset)
true (boolean) or Ingestion Complete (null) (Ingestion Complete)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "device_id": "string",
  • "metadata_changeset": {
    },
  • "ingestion_complete": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_file_record_by_path

Authorizations:
http
path Parameters
url_quoted_file_path
required
string
association_id
required
string
query Parameters
number or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_file_tags_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

abort_transactions

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
transaction_ids
required
Array of strings (Transaction Ids)

Responses

Request samples

Content type
application/json
{
  • "transaction_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null
}

images

Create, read, and modify entities within Roboto's 'images' domain

get_temporary_container_credentials

Access control

  • requires_org
Authorizations:
http
query Parameters
repository_uri
required
string
permissions
string
Enum: "ReadOnly" "ReadWrite"

Enum for permission levels of a Roboto resource. It is a best practice to only request/use the minimum permissions required for a given operation.

For example:

  • When listing files associated with a dataset or pulling a container image hosted in Roboto's registry, use ReadOnly permissions.
  • When adding files to a dataset or pushing a container image to Roboto's registry, use ReadWrite permissions.
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_container_image

Idempotently delete container image from Roboto's private registry.

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
image_uri
required
string (Image Uri)

Responses

Request samples

Content type
application/json
{
  • "image_uri": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

put_container_image_record

Admin only.

Memorialize a container image pushed into Roboto's private registry.

:meta private:

Access control

  • roboto_admin_only
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (ContainerImageRecord)

A wire-transmissible representation of a container image.

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "data": null
}

delete_container_image_record

Admin only.

Delete our record of container image that has been removed from Roboto's private registry.

:meta private:

Access control

  • roboto_admin_only
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
image_uri
required
string (Image Uri)

Responses

Request samples

Content type
application/json
{
  • "image_uri": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_container_image_record_deprecated

Retrieve our record of a container image pushed into Roboto's private registry.

Authorizations:
http
path Parameters
org_id
required
string
image_uri
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

list_image_records

Return paginated list of container image URIs pushed into Roboto's registry for a given org.

Access control

  • requires_org
Authorizations:
http
query Parameters
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_image_repository

Idempotently create a container image repository in Roboto's private registry. Repositories are namespaced by org.

Returns: The URI of the created repository.

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
repository_name
required
string (Repository Name)
immutable_image_tags
required
boolean (Immutable Image Tags)

Responses

Request samples

Content type
application/json
{
  • "repository_name": "string",
  • "immutable_image_tags": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_image_repository

Delete a container image repository in Roboto's private registry.

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
repository_name
required
string (Repository Name)
force
boolean (Force)
Default: false

Responses

Request samples

Content type
application/json
{
  • "repository_name": "string",
  • "force": false
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

repository_contains_image

Does the given Roboto-managed repository contain an image with the given image tag?

Because Roboto's view of its image registry is eventually consistent, it may be useful to poll this endpoint until it returns True or False to know when an image has been pushed to or deleted from Roboto's registry.

Access control

  • requires_org
Authorizations:
http
path Parameters
repo_name
required
string
image_tag
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

set_image_tag_mutability

Update an existing container image repository in Roboto's private registry to either allow or disallow overwriting of image tags.

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
repository_name
required
string (Repository Name)
immutable_image_tags
required
boolean (Immutable Image Tags)

Responses

Request samples

Content type
application/json
{
  • "repository_name": "string",
  • "immutable_image_tags": true
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

list_repository_records

Return paginated list of repositories within Roboto's registry for a given org.

Access control

  • requires_resource_owner
Authorizations:
http
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

integrations

Create, read, and modify entities within Roboto's 'integrations' domain

list_roboto_regions

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

register_s3_integration

Access control

  • deny_actions
  • deny_devices
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
account_id
required
string (Account Id)
aws_region
required
string (Aws Region)
bucket_name
required
string (Bucket Name)
org_id
required
string (Org Id)
transfer_accelerated
boolean (Transfer Accelerated)
Default: false
readonly
boolean (Readonly)
Default: false

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "aws_region": "string",
  • "bucket_name": "string",
  • "org_id": "string",
  • "transfer_accelerated": false,
  • "readonly": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

layouts

Create, read, and modify entities within Roboto's 'layouts' domain

query_layouts_for_org

Authorizations:
http
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_layout

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
accessibility
string (LayoutAccessibility)
Default: "user"
Enum: "organization" "user"

Controls layout accessibility between organization-wide or user-only.

required
object (Layout Definition)

The layout definition as a JSON object.

name
required
string (Name) <= 120 characters

The name of the layout.

schema_version
required
integer (Schema Version)

The schema version associated with the layout definition.

tags
Array of strings (Tags)

The tags associated with the layout.

Responses

Request samples

Content type
application/json
{
  • "accessibility": "organization",
  • "layout_definition": { },
  • "name": "string",
  • "schema_version": 0,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null
}

get_layout_by_id

Authorizations:
http
path Parameters
layout_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_layout

Authorizations:
http
path Parameters
layout_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
LayoutAccessibility (string) or NotSetType (any) (Accessibility)
Default: {}

Controls layout accessibility between organization-wide or user-only.

Layout Definition (object) or NotSetType (any) (Layout Definition)
Default: {}

The layout definition as a JSON object.

Name (string) or NotSetType (string) (Name) <= 120 characters
Default: {}

The name of the layout.

Schema Version (integer) or NotSetType (any) (Schema Version)
Default: {}

The schema version associated with the layout definition.

Array of Tags (strings) or NotSetType (any) (Tags)
Default: {}

The tags associated with the layout.

Responses

Request samples

Content type
application/json
{
  • "accessibility": { },
  • "layout_definition": { },
  • "name": { },
  • "schema_version": { },
  • "tags": { }
}

Response samples

Content type
application/json
{
  • "data": null
}

delete_layout

Authorizations:
http
path Parameters
layout_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": null
}

limits

Create, read, and modify entities within Roboto's 'limits' domain

get_limits_for_org

Authorizations:
http
path Parameters
org_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

notifications

Create, read, and modify entities within Roboto's 'notifications' domain

get_notifications_for_user

Access control

  • requires_org
Authorizations:
http
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
One of
string
Enum: "unread" "read"

Notification read status enum

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_notification

Access control

  • requires_org
Authorizations:
http
path Parameters
notification_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
notification_id
required
string (Notification Id)
ReadStatus (string) or null
Default: null
Lifecycle Status (object) or Lifecycle Status (null) (Lifecycle Status)
Default: null

Responses

Request samples

Content type
application/json
{
  • "notification_id": "string",
  • "read_status": null,
  • "lifecycle_status": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_notification

Access control

  • requires_org
Authorizations:
http
path Parameters
notification_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

put_notification_records

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
Array of objects (Requests)

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

orgs

Create, read, and modify entities within Roboto's 'orgs' domain

get_orgs_by_caller

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

update_org_user

Access control

  • org_admin_only
Authorizations:
http
path Parameters
org_id
required
string
url_encoded_user_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Array of Add Roles (strings) or Add Roles (null) (Add Roles)
Default: null
Array of Remove Roles (strings) or Remove Roles (null) (Remove Roles)
Default: null

Responses

Request samples

Content type
application/json
{
  • "add_roles": null,
  • "remove_roles": null
}

Response samples

Content type
application/json
{
  • "data": null
}

query

Create, read, and modify entities within Roboto's 'query' domain

convert_natural_language_to_roboql

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
prompt
required
string (Prompt)

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_query_record

Authorizations:
http
path Parameters
query_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_query_result_count

Authorizations:
http
path Parameters
query_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": 0
}

get_query_results

Authorizations:
http
path Parameters
query_id
required
string
query Parameters
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_recent_queries

Authorizations:
http
query Parameters
required
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": null
}

submit_roboql_query

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
Query (string) or Query (null) (Query)

The conditions, sorting behavior, and limit of this query.

target
required
string (QueryTarget)
Enum: "collections" "datasets" "files" "topics" "topic_message_paths" "events"

The type of data being requested, e.g. 'Datasets' or 'Topics'.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "target": "collections"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

submit_structured_query

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (QuerySpecification)

The conditions, sorting behavior, and limit of this query.

target
required
string (QueryTarget)
Enum: "collections" "datasets" "files" "topics" "topic_message_paths" "events"

The type of data being requested, e.g. 'Datasets' or 'Topics'.

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "target": "collections"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

submit_term_query

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
term
string (Term)
Default: ""

A string search term which this query will attempt to match across any appropriate fields.

target
required
string (QueryTarget)
Enum: "collections" "datasets" "files" "topics" "topic_message_paths" "events"

The type of data being requested, e.g. 'Datasets' or 'Topics'.

Responses

Request samples

Content type
application/json
{
  • "term": "",
  • "target": "collections"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

tokens

Create, read, and modify entities within Roboto's 'tokens' domain

list_tokens

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create_token

Access control

  • deny_actions
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
expiry_days
required
integer (Expiry Days)

Number of days until the token expires

name
required
string (Name)

A human-readable name for this token.

Description (string) or Description (null) (Description)
Default: null

An optional longer description for this token.

Responses

Request samples

Content type
application/json
{
  • "expiry_days": 0,
  • "name": "string",
  • "description": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deprecated_get_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deprecated_delete_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

disable_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

enable_token

Authorizations:
http
path Parameters
token_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

topics

Create, read, and modify entities within Roboto's 'topics' domain

create_topic

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (Association)

Use to declare an association between two Roboto entities.

topic_name
required
string (Topic Name)
End Time (integer) or End Time (null) (End Time)
Default: null
Message Count (integer) or Message Count (null) (Message Count)
Default: null
Metadata (object) or Metadata (null) (Metadata)
Default: null
Schema Checksum (string) or Schema Checksum (null) (Schema Checksum)
Default: null
Schema Name (string) or Schema Name (null) (Schema Name)
Default: null
Start Time (integer) or Start Time (null) (Start Time)
Default: null
Array of Message Paths (objects) or Message Paths (null) (Message Paths)
Default: null

Responses

Request samples

Content type
application/json
{
  • "association": {
    },
  • "topic_name": "string",
  • "end_time": null,
  • "message_count": null,
  • "metadata": null,
  • "schema_checksum": null,
  • "schema_name": null,
  • "start_time": null,
  • "message_paths": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_topics_by_association

Authorizations:
http
path Parameters
encoded_association
required
string
query Parameters
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_topic_by_name_and_association

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_topic

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

add_topic_message_path

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
message_path
required
string (Message Path)
data_type
required
string (Data Type)
canonical_data_type
required
string (CanonicalDataType)
Enum: "array" "boolean" "byte" "categorical" "image" "number" "number_array" "object" "string" "timestamp" "unknown" "latdegfloat" "londegfloat" "latdegint" "londegint"

Normalized data types used across different robotics frameworks.

Well-known and simplified data types that provide a common vocabulary for describing message path data types across different frameworks and technologies. These canonical types are primarily used for UI rendering decisions and cross-platform compatibility.

The canonical types abstract away framework-specific details while preserving the essential characteristics needed for data processing and visualization.

References: - ROS 1 field types: http://wiki.ros.org/msg - ROS 2 field types: https://docs.ros.org/en/iron/Concepts/Basic/About-Interfaces.html#field-types - uORB: https://docs.px4.io/main/en/middleware/uorb.html#adding-a-new-topic

Example mappings: - float32 -> CanonicalDataType.Number - uint8[] -> CanonicalDataType.Array - sensor_msgs/Image -> CanonicalDataType.Image - geometry_msgs/Pose -> CanonicalDataType.Object - std_msgs/Header -> CanonicalDataType.Object - string -> CanonicalDataType.String - char -> CanonicalDataType.String - bool -> CanonicalDataType.Boolean - byte -> CanonicalDataType.Byte

object (Metadata)

Initial key-value pairs to associate with this topic message path for discovery and search, e.g. { 'min': 0.71, 'max': 1.77, 'classification': 'my-custom-classification-tag' }

Responses

Request samples

Content type
application/json
{
  • "message_path": "string",
  • "data_type": "string",
  • "canonical_data_type": "array",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_topic_message_path

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
message_path
required
string (Message Path)
TaglessMetadataChangeset (object) or NotSetType (any) (Metadata Changeset)
Default: {}
Data Type (string) or NotSetType (any) (Data Type)
Default: {}
CanonicalDataType (string) or NotSetType (any) (Canonical Data Type)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "message_path": "string",
  • "metadata_changeset": { },
  • "data_type": { },
  • "canonical_data_type": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

add_message_path_representation

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (Association)

Use to declare an association between two Roboto entities.

storage_format
required
string (RepresentationStorageFormat)
Enum: "mcap" "parquet"

Supported storage formats for topic data representations.

Defines the available formats for storing and accessing topic data within the Roboto platform. Each format has different characteristics and use cases.

version
required
integer (Version)
message_path_id
required
string (Message Path Id)

Responses

Request samples

Content type
application/json
{
  • "association": {
    },
  • "storage_format": "mcap",
  • "version": 0,
  • "message_path_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

set_default_topic_representation

Authorizations:
http
path Parameters
encoded_association
required
string
url_quoted_topic_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (Association)

Use to declare an association between two Roboto entities.

storage_format
required
string (RepresentationStorageFormat)
Enum: "mcap" "parquet"

Supported storage formats for topic data representations.

Defines the available formats for storing and accessing topic data within the Roboto platform. Each format has different characteristics and use cases.

version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "association": {
    },
  • "storage_format": "mcap",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_all_topics_for_association

Access control

  • roboto_admin_only
Authorizations:
http
path Parameters
association_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_topic_by_id

Authorizations:
http
path Parameters
topic_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_topic

Authorizations:
http
path Parameters
topic_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
End Time (integer) or End Time (null) or End Time (null) (End Time)
Message Count (integer) or Message Count (null) (Message Count)
Schema Checksum (string) or Schema Checksum (null) or Schema Checksum (null) (Schema Checksum)
Schema Name (string) or Schema Name (null) or Schema Name (null) (Schema Name)
Start Time (integer) or Start Time (null) or Start Time (null) (Start Time)
MetadataChangeset (object) or Metadata Changeset (null) (Metadata Changeset)
MessagePathChangeset (object) or Message Path Changeset (null) (Message Path Changeset)

Responses

Request samples

Content type
application/json
{
  • "end_time": 0,
  • "message_count": 0,
  • "schema_checksum": "string",
  • "schema_name": "string",
  • "start_time": 0,
  • "metadata_changeset": {
    },
  • "message_path_changeset": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_message_path_representations

Authorizations:
http
path Parameters
topic_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_message_path_representations_by_format

Authorizations:
http
path Parameters
topic_id
required
string
storage_format
required
string
Enum: "mcap" "parquet"

Supported storage formats for topic data representations.

Defines the available formats for storing and accessing topic data within the Roboto platform. Each format has different characteristics and use cases.

header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_message_path_by_id

Authorizations:
http
path Parameters
message_path_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_topic_metadata_keys_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_all_unique_topic_message_path_metadata_keys_for_org

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_all_unique_topic_message_paths_for_org

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_unique_topic_names_for_org

Access control

  • requires_resource_owner
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

triggers

Create, read, and modify entities within Roboto's 'triggers' domain

create_trigger

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Action Digest (string) or Action Digest (null) (Action Digest)
Default: null
action_name
required
string (Action Name)
Action Owner Id (string) or Action Owner Id (null) (Action Owner Id)
Default: null
Array of Additional Inputs (strings) or Additional Inputs (null) (Additional Inputs)
Default: null
Array of Causes (strings) or Causes (null) (Causes)
Default: null
ComputeRequirements (object) or null
Default: null
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
ContainerParameters (object) or null
Default: null
enabled
boolean (Enabled)
Default: true
for_each
required
string (TriggerForEachPrimitive)
Enum: "dataset" "dataset_file"

Defines the granularity at which a trigger executes.

Determines whether the trigger creates one invocation per dataset or one invocation per file within datasets that match the trigger conditions.

name
required
string (Name) <= 256 characters [\w\-]+
Parameter Values (object) or Parameter Values (null) (Parameter Values)
Default: null
required_inputs
required
Array of strings (Required Inputs)
Service User Id (string) or Service User Id (null) (Service User Id)
Default: null
Timeout (integer) or Timeout (null) (Timeout)
Default: null

Responses

Request samples

Content type
application/json
{
  • "action_digest": null,
  • "action_name": "string",
  • "action_owner_id": null,
  • "additional_inputs": null,
  • "causes": null,
  • "compute_requirement_overrides": null,
  • "condition": null,
  • "container_parameter_overrides": null,
  • "enabled": true,
  • "for_each": "dataset",
  • "name": "string",
  • "parameter_values": null,
  • "required_inputs": [
    ],
  • "service_user_id": null,
  • "timeout": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_trigger_by_name

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
trigger_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_trigger

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
trigger_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Action Name (string) or Action Name (null) (Action Name)
Action Owner Id (string) or Action Owner Id (null) (Action Owner Id)
Action Digest (string) or Action Digest (null) or Action Digest (null) (Action Digest)
Array of Additional Inputs (strings) or Additional Inputs (null) or Additional Inputs (null) (Additional Inputs)
Array of Causes (strings) or Causes (null) (Causes)
ComputeRequirements (object) or Compute Requirement Overrides (null) or Compute Requirement Overrides (null) (Compute Requirement Overrides)
ContainerParameters (object) or Container Parameter Overrides (null) or Container Parameter Overrides (null) (Container Parameter Overrides)
Condition (object) or ConditionGroup (object) or Condition (null) or Condition (null) (Condition)
Enabled (boolean) or Enabled (null) (Enabled)
TriggerForEachPrimitive (string) or For Each (null) (For Each)
Parameter Values (object) or Parameter Values (null) or Parameter Values (null) (Parameter Values)
Array of Required Inputs (strings) or Required Inputs (null) (Required Inputs)
Timeout (integer) or Timeout (null) or Timeout (null) (Timeout)

Responses

Request samples

Content type
application/json
{
  • "action_name": "string",
  • "action_owner_id": "string",
  • "action_digest": "string",
  • "additional_inputs": [
    ],
  • "causes": [
    ],
  • "compute_requirement_overrides": {
    },
  • "container_parameter_overrides": {
    },
  • "condition": {
    },
  • "enabled": true,
  • "for_each": "dataset",
  • "parameter_values": { },
  • "required_inputs": [
    ],
  • "timeout": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_trigger

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
trigger_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_trigger_evaluations

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
trigger_name
required
string
query Parameters
limit
number
string or null
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

query_aggregated_triggers

Access control

  • requires_resource_owner_member
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_dataset_trigger_evaluations

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
dataset_id
required
string
query Parameters
limit
number
string or null
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_dataset_trigger_evaluations_summary

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
dataset_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_trigger_by_id

Authorizations:
http
path Parameters
trigger_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

query_triggers

Access control

  • requires_resource_owner_member
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Condition (object) or ConditionGroup (object) or Condition (null) (Condition)
Default: null
limit
integer (Limit)
Default: 1000
After (string) or After (null) (After)
Default: null
Sort By (string) or Sort By (null) (Sort By)
Default: null
SortDirection (string) or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "condition": null,
  • "limit": 1000,
  • "after": null,
  • "sort_by": null,
  • "sort_direction": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_scheduled_trigger

Access control

  • requires_org
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
action_name
required
string (Action Name) [\w\-]+
Action Owner Id (string) or Action Owner Id (null) (Action Owner Id)
Default: null
ComputeRequirements (object) or null
Default: null
ContainerParameters (object) or null
Default: null
enabled
required
boolean (Enabled)
InvocationInput (object) or null
Default: null
InvocationUploadDestination (object) or null
Default: null
name
required
string (Name) <= 256 characters [\w\-]+
Parameter Values (object) or Parameter Values (null) (Parameter Values)
Default: null
schedule
required
string (Schedule)
Timeout (integer) or Timeout (null) (Timeout)
Default: null

Responses

Request samples

Content type
application/json
{
  • "action_name": "string",
  • "action_owner_id": null,
  • "compute_requirement_overrides": null,
  • "container_parameter_overrides": null,
  • "enabled": true,
  • "invocation_input": null,
  • "invocation_upload_destination": null,
  • "name": "string",
  • "parameter_values": null,
  • "schedule": "string",
  • "timeout": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_scheduled_trigger_by_name

Access control

  • requires_resource_owner_member
Authorizations:
http
path Parameters
trigger_name
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_scheduled_trigger_by_id

Authorizations:
http
path Parameters
trigger_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_scheduled_trigger

Authorizations:
http
path Parameters
trigger_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Action Name (string) or NotSetType (any) (Action Name)
Default: {}
Action Owner Id (string) or NotSetType (any) (Action Owner Id)
Default: {}
ComputeRequirements (object) or NotSetType (any) or Compute Requirement Overrides (null) (Compute Requirement Overrides)
Default: {}
ContainerParameters (object) or NotSetType (any) or Container Parameter Overrides (null) (Container Parameter Overrides)
Default: {}
Enabled (boolean) or NotSetType (any) (Enabled)
Default: {}
InvocationInput (object) or NotSetType (any) or Invocation Input (null) (Invocation Input)
Default: {}
InvocationUploadDestination (object) or NotSetType (any) or Invocation Upload Destination (null) (Invocation Upload Destination)
Default: {}
Parameter Values (object) or NotSetType (any) or Parameter Values (null) (Parameter Values)
Default: {}
Schedule (string) or NotSetType (any) (Schedule)
Default: {}
Timeout (integer) or NotSetType (any) or Timeout (null) (Timeout)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "action_name": { },
  • "action_owner_id": { },
  • "compute_requirement_overrides": { },
  • "container_parameter_overrides": { },
  • "enabled": { },
  • "invocation_input": { },
  • "invocation_upload_destination": { },
  • "parameter_values": { },
  • "schedule": { },
  • "timeout": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_scheduled_trigger

Authorizations:
http
path Parameters
trigger_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_trigger_view_by_id

Authorizations:
http
path Parameters
trigger_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

users

Create, read, and modify entities within Roboto's 'users' domain

get_current_user

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

create_user

Access control

  • roboto_admin_only
  • deny_actions
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
user_id
required
string (User Id)
Name (string) or Name (null) (Name)
Default: null
is_service_user
boolean (Is Service User)
Default: false
is_system_user
boolean (Is System User)
Default: false
Picture Url (string) or Picture Url (null) (Picture Url)
Default: null
Array of Default Notification Channels (strings) or Default Notification Channels (null) (Default Notification Channels)
Default: ["email"]
Array of Default Notification Types (strings) or Default Notification Types (null) (Default Notification Types)
Default: ["comment_mention"]

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "name": null,
  • "is_service_user": false,
  • "is_system_user": false,
  • "picture_url": null,
  • "default_notification_channels": [
    ],
  • "default_notification_types": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

update_user

Access control

  • deny_actions
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
Name (string) or Name (null) (Name)
Default: null
Picture Url (string) or Picture Url (null) (Picture Url)
Default: null
Notification Channels Enabled (object) or Notification Channels Enabled (null) (Notification Channels Enabled)
Default: null
Notification Types Enabled (object) or Notification Types Enabled (null) (Notification Types Enabled)
Default: null

Responses

Request samples

Content type
application/json
{
  • "name": null,
  • "picture_url": null,
  • "notification_channels_enabled": null,
  • "notification_types_enabled": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete_user

Access control

  • deny_actions
Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

get_user_by_id

Authorizations:
http
path Parameters
user_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_invites_for_user

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list_orgs

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get_org_roles_for_user

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

whoami

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

viz

Create, read, and modify entities within Roboto's 'viz' domain

create_workspace

Authorizations:
http
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string
Request Body schema: application/json
required
object (Config)

Responses

Request samples

Content type
application/json
{
  • "config": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get_workspace

Authorizations:
http
path Parameters
workspace_id
required
string
header Parameters
X-Roboto-Org-Id
string
X-Roboto-User-Id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}