Browse the API reference

Get Operator Metadata

get/v1/graphs/{graph_id}/operator/{operator_type}

Part of Operator.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id
operator_typerequiredstringOperator type identifier (e.g., 'analyst', 'mapping')

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/operator/{operator_type}" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
namerequiredstring

Operator name

descriptionrequiredstring

Operator description

versionrequiredstring

Operator version

capabilitiesrequiredstring[]

Operator capabilities

supported_modesrequiredstring[]

Supported execution modes

requires_creditsrequiredboolean

Whether operator requires credits

authoroptionalstring

Operator author

tagsoptionalstring[]

Operator tags

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error