List topics
List topics in a dataset.
Consistency: Eventually Consistent (for API version >= 2026-03-13)
- Clients using API version < 2026-03-13: Strongly consistent reads
- Clients using API version >= 2026-03-13: Eventually consistent reads
- Override: Send X-Roboto-Connection-Consistency header to explicitly control behavior
This endpoint uses eventual consistency for improved performance and scalability. Results may not immediately reflect very recent writes. If you’ve just created or updated topics and don’t see them in the results, retry after a brief delay.
Access control
- Restricted tokens need the API scope
api.everything_else
/v1/datasets/{dataset_id}/topicsAuthorizationBearer token · headerrequireddataset_idstringrequiredpage_tokenstringX-Roboto-Org-IdstringX-Roboto-User-IdstringOK
dataobjectrequiredShow propertiesHide properties
itemsTopicRecord[]requiredShow propertiesHide properties
TopicRecordassociationAssociationrequiredUse to declare an association between two Roboto entities.
Show propertiesHide properties
association_idstringrequiredassociation_typeAssociationTyperequiredAssociationType is the Roboto domain entity type of the association.
datasetdevicefiletopicmessage_pathorgassociation_versioninteger | nullShow propertiesHide properties
integernullparentAssociation | nullShow propertiesHide properties
Association.nullcreatedstring<date-time>requiredcreated_bystringrequireddefault_representationRepresentationRecord | nullShow propertiesHide properties
associationAssociationrequiredUse to declare an association between two Roboto entities.
Show propertiesHide properties
association_idstringrequiredassociation_typeAssociationTyperequiredAssociationType is the Roboto domain entity type of the association.
datasetdevicefiletopicmessage_pathorgassociation_versioninteger | nullShow propertiesHide properties
integernullparentAssociation | nullShow propertiesHide properties
Association.nullcreatedstring<date-time>requiredformatstring | nullShow propertiesHide properties
stringnullmodifiedstring<date-time>requiredrepresentation_idstringrequiredstorage_formatRepresentationStorageFormatrequiredSupported 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.
mcapparquettopic_idstringrequiredtransformationsstring[]versionintegerrequirednullend_timeinteger | nullShow propertiesHide properties
integernullmessage_countinteger | nullShow propertiesHide properties
integernullmessage_pathsMessagePathRecord[]Show propertiesHide properties
MessagePathRecordcanonical_data_typeCanonicalDataTyperequiredNormalized 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
arraybooleanbytecategoricalimagenumbernumber_arrayobjectstringtimestampunknownlatdegfloatlondegfloatlatdegintlondegintcreatedstring<date-time>requiredcreated_bystringrequireddata_typestringrequiredmessage_pathstringrequiredmessage_path_idstringrequiredmetadataobjectmodifiedstring<date-time>requiredmodified_bystringrequiredorg_idstringrequiredpath_in_schemastring[]requiredrepresentationsRepresentationRecord[]Show propertiesHide properties
RepresentationRecordassociationAssociationrequiredUse to declare an association between two Roboto entities.
createdstring<date-time>requiredformatstring | nullShow propertiesHide properties
stringnullmodifiedstring<date-time>requiredrepresentation_idstringrequiredstorage_formatRepresentationStorageFormatrequiredSupported 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.
mcapparquettopic_idstringrequiredtransformationsstring[]versionintegerrequiredsource_pathstringrequiredtopic_idstringrequiredmetadataobjectmodifiedstring<date-time>requiredmodified_bystringrequiredorg_idstringrequiredschema_checksumstring | nullShow propertiesHide properties
stringnullschema_idstring | nullShow propertiesHide properties
stringnullschema_namestring | nullShow propertiesHide properties
stringnullstart_timeinteger | nullShow propertiesHide properties
integernulltopic_idstringrequiredtopic_namestringrequirednext_tokenstring | nullShow propertiesHide properties
stringnulltotal_countinteger | nullShow propertiesHide properties
integernullThrown 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.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown when authentication fails
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown if an operation would exceed a user or org level limit.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown if a user is attempting to perform an action unrecognized by the Roboto platform.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown if there is a conflict between a resource you're creating and another existing resource
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown if a resource is missing or expired.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullAn 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.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown by shimmed out APIs which have not yet been implemented
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown 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.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | nullThrown 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.
errorobjectShow propertiesHide properties
error_codenumbermessagestringstack_tracestring | null