Build something for your railway.
Build with JavaScript calls, complete workflows or the Node starter.
Source 0.1.0 Private source package
Make a first request
Choose your client and read one authorised layout.
Start with the guideFind a JavaScript example
Start with a short call, then explore workflows and types when you need them.
Choose a featureExplore the Node starter
An optional terminal project connects selection, edits and recovery with local fixtures.
See what the starter doesRead a layout snapshot
With an authenticated client configured for your integration, await the result. Replace these fictional account and layout identifiers with your selected development records. Errors pass to your caller; this read does not operate the railway.
const result = await client.currentState.getLayoutSnapshot(
"account-1",
"layout-1",
{}
);Know where to start
The SDK is currently a private source package at version 0.1.0. These guides describe the reviewed source checkpoint. Hosted SDK distribution is planned; its infrastructure, a public package and self-service integration registration are not available yet.
The SDK is a JavaScript library which prepares API requests and decodes responses. TypeScript adds optional type checking. Node runs the downloadable terminal starter; the HTTP API does not require Node. Other languages can call the API directly with the required authentication.
Choose the audience that fits your integration. A named non-browser integration and a guest viewer use different clients and different authority. Neither grants access to private Administration or device credentials.