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

Create dataset if not exists

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope datasets.create
POST/v1/datasets/create_if_not_exists
Authorization
AuthorizationBearer token · headerrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
match_roboql_querystringrequired
create_requestCreateDatasetRequestrequired

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.

Show properties
descriptionstring | null

An optional human-readable description for this dataset.

default: null
Show properties
Any of:
string
string
null
null
device_idstring | null

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

default: null
Show properties
Any of:
string
string
null
null
namestring | null

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

default: null
Show properties
Any of:
string
string
null
null
metadataobject

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

tagsstring[]

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

custom_fieldsobject | null

Initial values for custom fields defined on Datasets in the caller's org, e.g. { 'drone_id': 'DJI-X', 'flight_count': 12 }. Each name must match a Ready custom-field definition for the org's Dataset entity type; values are typed against the field's declared type.

default: null
Show properties
Any of:
object
object
null
null
Responses
200

OK

dataobjectrequired

Wire-transmissible representation of a dataset in the Roboto platform.

DatasetRecord contains all the metadata and properties associated with a dataset, including its identification, timestamps, metadata, tags, and organizational information. This is the data structure used for API communication and persistence.

DatasetRecord instances are typically created by the platform during dataset creation operations and are updated as datasets are modified. The Dataset domain class wraps DatasetRecord to provide a more convenient interface for dataset operations.

The record includes audit information (created/modified timestamps and users), organizational context, and user-defined metadata and tags for discovery and organization purposes.

Show properties
createdstring<date-time>required
created_bystringrequired
dataset_idstringrequired
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
device_idstring | null
default: null
Show properties
Any of:
string
string
null
null
metadataobject
custom_fieldsobject
modifiedstring<date-time>required
modified_bystringrequired
namestring | null
default: null
Show properties
Any of:
string
string
null
null
org_idstringrequired
roboto_record_versioninteger
default: 0
tagsstring[]
administratorstring
default: "Roboto"
storage_ctxobject
storage_locationstring
default: "S3"
400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
401

Thrown when authentication fails

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
403

Thrown if an operation would exceed a user or org level limit.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
410

Thrown if a resource is missing or expired.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
501

Thrown by shimmed out APIs which have not yet been implemented

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.roboto.ai/v1/datasets/create_if_not_exists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "match_roboql_query": "string",
  "create_request": {
    "description": null,
    "device_id": null,
    "name": null,
    "metadata": {},
    "tags": [
      "string"
    ],
    "custom_fields": null
  }
}'
Response
{
  "data": {
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "dataset_id": "string",
    "description": null,
    "device_id": null,
    "metadata": {},
    "custom_fields": {},
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string",
    "name": null,
    "org_id": "string",
    "roboto_record_version": 0,
    "tags": [
      "string"
    ],
    "administrator": "Roboto",
    "storage_ctx": {},
    "storage_location": "S3"
  }
}