Update topic message path by id

Access control

Restricted tokens need the API scope api.everything_else

PUT/v1/topics/id/{topic_id}/message-path

Authorization

AuthorizationBearer token · headerrequired

Path parameters

topic_idstringrequired

Header parameters

X-Roboto-Org-Idstring

X-Roboto-User-Idstring

Request body

requiredapplication/json

message_pathstringrequired

metadata_changesetTaglessMetadataChangeset | null

Show properties

Any of:

TaglessMetadataChangeset

put_fieldsobject | null

default: null

Show properties

Any of:

object

object

null

null

remove_fieldsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

string[]

Array of string

string

null

null

replace_allboolean

default: false

null

null

data_typestring | null

Show properties

Any of:

string

string

null

null

canonical_data_typeCanonicalDataType | null

Show properties

Any of:

CanonicalDataType

string

null

null

path_in_schemastring[] | null

Show properties

Any of:

string[]

Array of string

string

null

null

Responses

200

dataobjectrequired

Record representing a message path within a topic.

Defines a specific field or signal within a topic's data schema, including its data type, metadata, and statistical information. Message paths use dot notation to specify nested attributes within complex message structures.

Message paths are the fundamental units for accessing individual data elements within time-series robotics data, enabling fine-grained analysis and visualization of specific signals or measurements.

Show properties

canonical_data_typeCanonicalDataTyperequired

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

Allowed:arraybooleanbytecategoricalimagenumbernumber_arrayobjectstringtimestampunknownlatdegfloatlondegfloatlatdegintlondegint

createdstring<date-time>required

created_bystringrequired

data_typestringrequired

message_pathstringrequired

message_path_idstringrequired

metadataobject

modifiedstring<date-time>required

modified_bystringrequired

org_idstringrequired

path_in_schemastring[]required

representationsRepresentationRecord[]

Show properties

Array of RepresentationRecord

associationAssociationrequired

Use to declare an association between two Roboto entities.

Show properties

association_idstringrequired

association_typeAssociationTyperequired

AssociationType is the Roboto domain entity type of the association.

Allowed:datasetdevicefiletopicmessage_pathorg

association_versioninteger | null

default: null

Show properties

Any of:

integer

integer

null

null

parentAssociation | null

default: null

Show properties

Any of:

Association

Circular reference to Association.

null

null

createdstring<date-time>required

formatstring | null

default: null

Show properties

Any of:

string

string

null

null

modifiedstring<date-time>required

representation_idstringrequired

storage_formatRepresentationStorageFormatrequired

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.

Allowed:mcapparquet

topic_idstringrequired

transformationsstring[]

versionintegerrequired

source_pathstringrequired

topic_idstringrequired

400

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

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

401

Thrown when authentication fails

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

403

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

404

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

409

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

410

Thrown if a resource is missing or expired.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

500

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

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

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

501

Thrown by shimmed out APIs which have not yet been implemented

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

503

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

504

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

507

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

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

X-Roboto-Org-IdheaderX-Roboto-User-Idheadertopic_idpath*

Bodyapplication/json

message_pathstring*metadata_changesetstringdata_typestringcanonical_data_typestringpath_in_schemastring

Request

curl -X PUT 'https://api.roboto.ai/v1/topics/id/string/message-path' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "message_path": "string",
  "metadata_changeset": {
    "put_fields": null,
    "remove_fields": null,
    "replace_all": false
  },
  "data_type": "string",
  "canonical_data_type": "array",
  "path_in_schema": [
    "string"
  ]
}'

const response = await fetch("https://api.roboto.ai/v1/topics/id/string/message-path", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"message_path\": \"string\",\n  \"metadata_changeset\": {\n    \"put_fields\": null,\n    \"remove_fields\": null,\n    \"replace_all\": false\n  },\n  \"data_type\": \"string\",\n  \"canonical_data_type\": \"array\",\n  \"path_in_schema\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.put(
    "https://api.roboto.ai/v1/topics/id/string/message-path",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"message_path\": \"string\",\n  \"metadata_changeset\": {\n    \"put_fields\": null,\n    \"remove_fields\": null,\n    \"replace_all\": false\n  },\n  \"data_type\": \"string\",\n  \"canonical_data_type\": \"array\",\n  \"path_in_schema\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "data": {
    "canonical_data_type": "array",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "data_type": "string",
    "message_path": "string",
    "message_path_id": "string",
    "metadata": {},
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string",
    "org_id": "string",
    "path_in_schema": [
      "string"
    ],
    "representations": [
      {
        "association": {
          "association_id": "string",
          "association_type": "dataset",
          "association_version": null,
          "parent": null
        },
        "created": "2019-08-24T14:15:22Z",
        "format": null,
        "modified": "2019-08-24T14:15:22Z",
        "representation_id": "string",
        "storage_format": "mcap",
        "topic_id": "string",
        "transformations": [
          "string"
        ],
        "version": 0
      }
    ],
    "source_path": "string",
    "topic_id": "string"
  }
}

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

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

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

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

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

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

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

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

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

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

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