RapidPlan Realtime Controller ASCII API

The ASCII API is the primary runtime integration surface for the Realtime Controller. A client opens a TCP socket to the controller and exchanges inline YAML 1.2 command strings (topic / type / id / data) terminated with CR+LF; responses come back as inline YAML or, after SetResponseType, as CSV. Version 2.9 documents roughly seventy commands across four groups: Project (SetResponseType, GetUnits, SetUnits, GetMode, ClearFaults, LoadProject, GetLoadedProject, UnloadProject, SetDefaultProject, EnterOperationMode, EnterConfigurationMode, Shutdown, UserLog, BeginInterlockRecording, GenerateInterlockData), Robot (ActivateRobots, DeactivateRobot, Connect, Disconnect, AcquireControl, ReleaseControl, SetMaxLinearAcceleration, SetMaxLinearSpeed, SetAlternateLocation, SetInterruptBehavior, SetRobotPreset, GetRobotPresets, Move, CombinedMove, CancelMove, HoldMove, ResumeMove, GetTargets, CreateTarget, UpdateTarget, RenameTarget, RemoveTarget, AddConnection, RemoveConnection, GetJointConfiguration, GetTCPPose, IsOnTarget), Scene Modeling (GetObjectStates, GetStatefulObjects, SetObjectState, GetFrames, AddFrame, UpdateFrame, RemoveFrames, AddBox, AddObject, RemoveBoxes, RemoveObjects, Reparent) and the combined SetWorkcellState. No OpenAPI is published for it.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/rapidplan-ascii-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

API entry from apis.yml

apis.yml Raw ↑
aid: realtime-robotics:rapidplan-ascii-api
name: RapidPlan Realtime Controller ASCII API
description: 'The ASCII API is the primary runtime integration surface for the Realtime Controller. A
  client opens a TCP socket to the controller and exchanges inline YAML 1.2 command strings (topic / type
  / id / data) terminated with CR+LF; responses come back as inline YAML or, after SetResponseType, as
  CSV. Version 2.9 documents roughly seventy commands across four groups: Project (SetResponseType, GetUnits,
  SetUnits, GetMode, ClearFaults, LoadProject, GetLoadedProject, UnloadProject, SetDefaultProject, EnterOperationMode,
  EnterConfigurationMode, Shutdown, UserLog, BeginInterlockRecording, GenerateInterlockData), Robot (ActivateRobots,
  DeactivateRobot, Connect, Disconnect, AcquireControl, ReleaseControl, SetMaxLinearAcceleration, SetMaxLinearSpeed,
  SetAlternateLocation, SetInterruptBehavior, SetRobotPreset, GetRobotPresets, Move, CombinedMove, CancelMove,
  HoldMove, ResumeMove, GetTargets, CreateTarget, UpdateTarget, RenameTarget, RemoveTarget, AddConnection,
  RemoveConnection, GetJointConfiguration, GetTCPPose, IsOnTarget), Scene Modeling (GetObjectStates, GetStatefulObjects,
  SetObjectState, GetFrames, AddFrame, UpdateFrame, RemoveFrames, AddBox, AddObject, RemoveBoxes, RemoveObjects,
  Reparent) and the combined SetWorkcellState. No OpenAPI is published for it.'
humanURL: https://realtimerobotics.atlassian.net/wiki/spaces/rapidplandocs/pages/3467120890/2.9+Realtime+Robotics+RapidPlan+ASCII+API
baseURL: tcp://{realtime_controller_host}:9999
tags:
- Motion Planning
- Robotics
- Industrial Automation
properties:
- type: Documentation
  url: https://realtimerobotics.atlassian.net/wiki/spaces/rapidplandocs/pages/3467120890/2.9+Realtime+Robotics+RapidPlan+ASCII+API
- type: APIReference
  url: https://realtimerobotics.atlassian.net/wiki/spaces/rapidplandocs/pages/3467120890/2.9+Realtime+Robotics+RapidPlan+ASCII+API