Ecosystem · generate, convert, consume
Roadbook integrations
Roadbook is an open JSON interchange format for complete travel itineraries. Anything that writes or reads a .roadbook.json file is an integration. This page lists what exists today and what is planned — planned items are clearly marked and should not be relied upon yet.
status legend
available ✓
in preparation ◐
planned / example ○
Generate#
Any tool that can emit JSON can produce a Roadbook. No registration, API key or permission is required.
| Integration | Status | Notes |
|---|---|---|
AI assistants | ✓ | ChatGPT, Claude, Gemini, Perplexity, local models: the prompt builder produces a tailored prompt; the assistant generates the file from the public spec and schema. Workflow → |
scripts | ✓ | Build the object, serialize to JSON, validate with roadbook-validate.mjs or the JSON Schema. See examples for the shape of each feature. |
official player — conversational builder | ✓ | The official player roadbook.plus ships an AI assistant that creates and edits trips from a conversation and exports .roadbook.json. |
structured output (AI APIs) | ✓ | Use the JSON Schema as the response schema, then run the validator for integrity rules. |
travel planners / agency back-offices | ○ | Any planner can export Roadbook. None is listed yet — submit yours. |
Convert#
Importers turning existing material into Roadbook. None of these converters exists as an official tool today; they are listed as natural targets, and the format already has the fields to receive their output.
| Source | Status | Maps to |
|---|---|---|
e-mail confirmations | ○ | bookings (refs, payment, check-in/out, tickets with real payloads), transport details for flights and trains. |
PDF itineraries / vouchers | ○ | days + items, bookings, tickets.voucher (kept as a URL), people for guides and drivers. |
calendar (iCalendar) | ○ | Events → items with time/endTime, locations → place; the reverse export (Roadbook → iCal) is a common player feature. |
booking / OTA exports | ○ | bookings with structured transport, rooms, payment.payer for corporate travel. |
GPX / KML routes | ○ | route.km, day coords, item coords; the track itself stays a separate file. |
Building one of these? The spec and examples show the target shape; validate your output and tell us so it can be listed here.
Consume#
| Integration | Status | Notes |
|---|---|---|
roadbook.plus — official player | ✓ | roadbook.plus: offline-first PWA: today / trip / tickets / info, per-traveler links and roles, scannable tickets, surprise mode, plan B, sync, import/export. Details → |
validator — web / CLI / ESM / HTTP | ✓ | validator.html (local, nothing uploaded), node cli.mjs file, import { validateRoadbook } from 'roadbook-validate.mjs'. Errors copyable as an AI repair prompt. |
minimal renderer | ✓ | roadbook-view.mjs — read-only HTML rendering, MIT, a starting point for your own viewer. |
compatible third-party viewers | ○ | None listed yet. Submit yours; requirements in compatibility. |
Developer tooling#
| Tool | Status | Notes |
|---|---|---|
JSON Schema | ✓ | roadbook.schema.json, draft 2020-12. Usage → |
@roadbookformat/validate (npm) | ◐ | Package in preparation, wrapping the reference validator and the schema with zero dependencies: import { validateRoadbook } from '@roadbookformat/validate'. Not published yet — use the ESM file directly meanwhile. |
GitHub repository | ◐ | A public repository (spec, schema, validator, examples, tests) is being prepared. Until it is published, this site is the canonical distribution. |
Python helper | ○ | Possible later (roadbook-format). Meanwhile validate with jsonschema against the schema — snippet. |
tests | ✓ | All examples validate against the schema and the reference validator; internal links, sitemap and llms.txt URLs are checked. |
Agents#
| Tool | Status | Notes |
|---|---|---|
llms.txt / llms-full.txt | ✓ | Concise index and self-contained summary of the format for AI crawlers and agents. |
MCP server | ○ | Planned: create / validate / repair tools reusing the reference validator, implemented on the official player side. Design note → |
HTTP validation API | ✓ | POST https://roadbookformat.org/api/validate (or GET ?url=) — the reference validator for agents that can only make HTTP calls; stateless, CORS open. Local validation stays the primary path. Docs → |