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

Get bindable topic message paths

Get the distinct message paths of a single topic, by name, with their types and units.

Resolves the topic the same way as GET /v1/topics/unique/topic_fields, but returns one entry per distinct message path rather than the path alone, carrying the type and unit the topic’s schema versions agree on. Lets the joint-binding dialog tell a scalar path from an array one without reading a message, and gives field autocomplete something to show beside each path.

An attribute is populated only when every contributing schema version agrees on it; on disagreement it is null and named in the entry’s conflicting_attributes, so a caller can never mistake disagreement for an unset value.

topic_name is a query parameter rather than a path segment because topic names contain slashes (/imu/data).

Reads only the normalized schema tables. A topic with no normalized rows yet (e.g. one predating the topic-schema tables) returns an empty list.

Consistency: Eventually consistent by default; override with the X-Roboto-Connection-Consistency header.

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope api.everything_else
GET/v1/urdf/bindable_topic_message_paths
Authorization
AuthorizationBearer token · headerrequired
Query parameters
topic_namestring
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Responses
200

OK

dataobject[]required
Show properties
Array of object
pathstringrequired
canonical_data_typeCanonicalDataType | null
default: null
Show properties
Any of:
CanonicalDataType
string
null
null
data_typestring | null
default: null
Show properties
Any of:
string
string
null
null
unitstring | null
default: null
Show properties
Any of:
string
string
null
null
conflicting_attributesUrdfBindableTopicMessagePathAttribute[]
default: []
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
Request
curl -X GET 'https://api.roboto.ai/v1/urdf/bindable_topic_message_paths' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": [
    {
      "path": "string",
      "canonical_data_type": null,
      "data_type": null,
      "unit": null,
      "conflicting_attributes": []
    }
  ]
}