Roger ATC Copilot API

Version 1.50.0 · reads everything; writes the pilot’s records with a key allowed to write · openapi.json

A flight plan from A to Z

Build the planning, read its navigation log, turn it into the ICAO plan, complete and validate it, file it — then log the hours. Every step is the app’s own function, and every record reaches the pilot’s devices.

1. The aircraft (once)

curl -X POST -H "Content-Type: application/json" -d '{"registration":"LV-ABC","icaoType":"C172","category":"singleEnginePiston","wakeTurbulence":"L","cruiseTas":105,"cruiseFuelBurn":32,"usableFuel":200,"taxiFuel":4,"volumeUnit":"l","equipmentCodes":"SDFGY","surveillanceCodes":"C","colourAndMarkings":"WHITE RED STRIPES"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft

2. The planning: route, aircraft, time, level, fuel, wind

curl -X POST -H "Content-Type: application/json" -d '{"name":"San Fernando – Rosario","departure":"SADF","route":[{"ident":"FDO","kind":"navaid"},{"airway":"W5","to":"ROS"}],"destination":"SAAR","alternates":["SAAV"],"aircraftId":"3f0c2b6e-8a1d-4c55-9e0a-2d7b6f1c9a40","departureAt":"2026-10-10T13:00:00Z","cruiseAltitudeFt":4500,"flightRules":"V","fuelAtDeparture":150,"reserveMinutes":45,"windSource":"manual","manualWind":{"fromTrueDeg":270,"speedKt":15}}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings

3. Its navigation log: legs, headings, times, fuel

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{planningId}/navlog

4. The ICAO flight plan it becomes (a draft, with its validation)

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{planningId}/flight-plan

5. What only the pilot can state: persons on board, field 19

curl -X PATCH -H "Content-Type: application/json" -d '{"supplementary":{"personsOnBoard":2,"survivalEquipment":{"jungle":false}},"other":{"rmk":"VUELO DE INSTRUCCION"}}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{planId}

6. Check it as the app does

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{planId}/validation

7. Mark it filed (refused while the validator reports an error)

curl -X PATCH -H "Content-Type: application/json" -d '{"status":"filed"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{planId}

8. After the flight: the hours, in the logbook

curl -X POST -H "Content-Type: application/json" -d '{"date":"2026-10-09","departureAt":"2026-10-09T13:05:00Z","arrivalAt":"2026-10-09T14:55:00Z","departureAerodrome":"SADF","arrivalAerodrome":"SAAR","kind":"crossCountry","role":"pilot","registration":"LV-ABC","purpose":"VP","landings":1,"remarks":"Travesía a Rosario"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook

9. And close the plan

curl -X PATCH -H "Content-Type: application/json" -d '{"status":"flown"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{planId}

Authentication

Every route except /v1/health needs the personal API key from Settings → API in the app, sent as Authorization: Bearer rat_live_… or X-API-Key: rat_live_…. The key reads everything in the account, including the pilot profile: keep it on a server, never in a web page or a mobile app. Rotating it in Settings invalidates the old key immediately.

Responses

Every body is JSON with data and meta (requestId, generatedAt); collections add page (limit, total, nextCursor). Records are returned whole, with every field the app stores. Times are UTC ISO 8601, durations whole minutes. A value the app does not know is null or absent, never invented.

StatusCodeMeaning
400bad_requestA parameter is malformed. The message says which.
401unauthorizedNo key, a malformed key, a rotated key, or a paused account.
403account_suspendedA paused account, on POST /v1/plugin/activation and GET /v1/plugin/credentials only (every other route answers 401).
403credentials_disabledGET /v1/plugin/credentials only: the pilot turned off “RogerATC may read my provider keys” in the app, Settings → API (1.28.0).
403insufficient_scopeA read-only key on a route that changes the pilot’s records. The pilot allows writes in the app, Settings → API.
404not_foundNo such route, or no such record in this account.
405method_not_allowedA method the path does not take. Allow lists the ones it does.
409conflictThe write clashes with what is stored: a registration or an aerodrome card the account already has, a past flight plan that is read-only, or a record that changed while the request was applied (read it again and retry).
410goneThe record was deleted in the app: a plugin session (stop sending it), or the id an Idempotency-Key or body id names.
412precondition_failedIf-Match names a version the record no longer is. ETag carries the current one.
413payload_too_largeA write body over its limit: 512 KB for a session, 32 KB for a live report, 8 KB for an activation.
415unsupported_media_typeA write body that is not application/json.
422unprocessableThe body is well-formed JSON the app would refuse. error.problems lists every problem: field, code, message.
429rate_limitedOver 120 requests a minute for this key. Retry after Retry-After seconds.
500internalOur fault. The requestId in meta identifies the request in our logs.
503unavailableA write could not be stored just now. Retry after Retry-After seconds.

Service

GET /v1/health no key

Service health. Answers without a key, touches no data and is not counted. For uptime monitoring.

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/health

GET /v1/me

The account this key belongs to. The account id, email and name, and the key’s own dates. The cheapest way for an integration to check its key works.

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/me

Aerodromes

GET /v1/aerodromes

Aerodrome cards. Every aerodrome card in the account, with every field: frequencies, contacts, navaids, runways, taxiways, fuel, position, notes, the NOTAM and MADHEL notes the pilot copied. Sorted by identifier.

Fields: src/core/airfields/types.ts (Airfield)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes

GET /v1/aerodromes/{id}

One aerodrome card. By card id, or by the aerodrome’s identifier (SADF, or a national code such as LEN), case-insensitive.

Fields: src/core/airfields/types.ts (Airfield)

ParameterInDescription
idpath, requiredThe card id, or the aerodrome identifier.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/{id}

GET /v1/aerodromes/{id}/attachments/{attachmentId}

Download link for an aerodrome attachment. A diagram, procedure or photo the pilot attached to the card (listed in the card’s attachments). Returns the attachment’s metadata and a presigned HTTPS URL to the file itself, valid for 15 minutes; fetch it without the API key. 404 when the card does not name that attachment, or its file has not been uploaded yet.

Fields: src/core/files/attachments.ts (Attachment)

ParameterInDescription
idpath, requiredThe card id, or the aerodrome identifier.
attachmentIdpath, requiredThe id of one entry in the card’s attachments.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/{id}/attachments/{attachmentId}

GET /v1/aerodrome-comments/{ident}

Pilots’ comments on an aerodrome. What pilots wrote about an aerodrome and an administrator approved, newest first, each with the author’s first name and surname initial only (authorName, or null) — plus this account’s own comments in any status (pending, rejected). The same list the aerodrome card shows. Any code of the aerodrome finds it (SADF, FDO). Read-only: comments are written and moderated in the app. **No photo URLs** — hasPhoto says one exists and photoUrl and thumbUrl are always null, because the photos are served only to the app, through URLs its own backend signs.

Fields: src/core/community/aerodromeComments.ts (AerodromeComment)

ParameterInDescription
identpath, requiredThe aerodrome: ICAO indicator, IATA or national code.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodrome-comments/{ident}

GET /v1/aerodrome-knowledge

What the EFB knows around a position. The aerodromes within radiusNm of a position, nearest first — from the bundled reference database (OurAirports) and the pilot’s own cards — each with its distance, the pilot’s card whole when there is one, and the reference block; and areaFrequencies, the TMA frequencies the pilot wrote on cards within the radius — each with the pilot’s own name for it (since 1.24.0) — each name and value once, with the card it came from. **No upstream is asked** (no MADHEL, NOTAMs or weather): call the {ident} form for those. Every block names its source. Airspace is not here: openAIP is read with the pilot’s own key, by the client.

Fields: src/core/plugin/knowledge.ts

ParameterInDescription
latquery, requiredLatitude, decimal degrees, −90…90.
lonquery, requiredLongitude, decimal degrees, −180…180.
radiusNmqueryNautical miles, 1–100. Default 25.
limitqueryAerodromes to return, 1–20. Default 8.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodrome-knowledge

GET /v1/aerodrome-knowledge/{ident}

Everything the EFB knows about one aerodrome. One answer joined on every code the field answers to (SADM, MOR, the card’s own): card — the pilot’s card, whole, with its date, and card.activities (1.48.0) — gliders, parachuting, model aircraft and drones the pilot switched on, an empty list meaning nothing noted, never nothing there; reference — the bundled OurAirports record (runways, published frequencies); madhel — ANAC’s MADHEL page, verbatim prose, status record/none/unknown/unavailable; notams — ANAC’s NOTAMs in force, status notams/none/unknown/unavailable, at most 25 with total; weather — as /v1/weather/{ident}; areaWeather (1.47.0) — the FIR from ANAC’s MADHEL, the SIGMETs in force there (status sigmets/none/unknown/unavailable, raw text, validity, whether the area covers the field; from NOAA’s relay of the WMO network) and the PRONAREA as not_fetched with the SMN page a person opens, null for a field outside Argentina. Every block carries its source and when it was fetched; nothing is merged across sources, and only none means there is nothing. Upstreams are cached per container (MADHEL a day, NOTAMs ten minutes, weather five). A field outside the region that the worldwide index carries comes back with world — identification only, no runways or frequencies — and ANAC is never asked about it (madhel and notams say unknown). A well-formed code that no source knows is **not** an error (since 2026-10-17): 200 with known: false, every block null or unknown, cached an hour.

Fields: src/core/plugin/knowledge.ts

ParameterInDescription
identpath, requiredAn ICAO location indicator (SADM) or a national code (MOR, LEN), 3–4 letters or digits.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodrome-knowledge/{ident}

GET /v1/airways

ATS routes (airways). Argentina’s lower and upper ATS routes from AIP Argentina ENR 3.1/3.2, with significant points from ENR 4.4, as the app draws them: designator, lower/upper, conventional/RNAV, points in order with positions, and the published distance of each segment. source names the editions. Limits, minimum flight levels and direction of cruising levels are not included.

Fields: src/core/airways/index.ts (Airway)

ParameterInDescription
airspacequerylower or upper. Both when absent.
designatorqueryOne route, e.g. W5 or UL780.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/airways

POST /v1/aerodromes

Create a aerodrome card. A card for one aerodrome, prefilled from the bundled database exactly as the app’s “Add aerodrome” (runways with magnetic headings at the pilot’s declination), then the body’s fields over it. code is resolved to the aerodrome’s identity (AEP is SABE); a second card for the same aerodrome is 409 conflict. attachments is refused. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/airfields/types.ts (Airfield)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"code":"SADF","notes":"Combustible hasta las 18 LT"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes

PATCH /v1/aerodromes/{id}

Update a aerodrome card. JSON Merge Patch of the card, **by card id** (the GET also takes an identifier; writes do not). A new code is resolved and checked for a duplicate. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/airfields/types.ts (Airfield)

ParameterInDescription
idpath, requiredThe aerodrome card id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/{id}

PUT /v1/aerodromes/{id}

Replace a aerodrome card. Replaces the card whole; attachments are kept. If-Match makes it conditional.

Fields: src/core/airfields/types.ts (Airfield)

ParameterInDescription
idpath, requiredThe aerodrome card id.

Needs a key allowed to write.

curl -X PUT -H "Content-Type: application/json" -d '{"code":"SADF","notes":"Combustible hasta las 18 LT"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/{id}

DELETE /v1/aerodromes/{id}

Delete a aerodrome card. Deletes the card with a tombstone. Its diagrams stay in storage until deleted from the app. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/airfields/types.ts (Airfield)

ParameterInDescription
idpath, requiredThe aerodrome card id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/{id}

Aircraft

GET /v1/aircraft

Aircraft. Every aircraft profile, with every field: registration, type, equipment, speeds, fuel, weight and balance, envelope. Sorted by registration.

Fields: src/core/aircraft/types.ts (AircraftProfile)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft

GET /v1/aircraft/{id}

One aircraft. By aircraft id.

Fields: src/core/aircraft/types.ts (AircraftProfile)

ParameterInDescription
idpath, requiredThe aircraft id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft/{id}

GET /v1/aircraft/{id}/attachments/{attachmentId}

Download link for an aircraft document. A flight manual, an aircraft document or a photo the pilot attached to the aircraft (listed in its attachments). Returns the attachment’s metadata and a presigned HTTPS URL to the file itself, valid for 15 minutes; fetch it without the API key. 404 when the aircraft does not name that attachment, or its file has not been uploaded yet.

Fields: src/core/files/attachments.ts (Attachment)

ParameterInDescription
idpath, requiredThe aircraft id.
attachmentIdpath, requiredThe id of one entry in the aircraft’s attachments.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft/{id}/attachments/{attachmentId}

POST /v1/aircraft

Create a aircraft. An aircraft profile, on the app’s blank one (createEmptyAircraft). registration is required, and one the fleet already holds (LV-ABC, lvabc alike) is 409 conflict. Every field the app’s blank has keeps its type; attachments is refused — files are uploaded in the app. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/aircraft/types.ts (AircraftProfile)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"registration":"LV-ABC","icaoType":"C172","category":"singleEnginePiston","wakeTurbulence":"L","cruiseTas":105,"cruiseFuelBurn":32,"usableFuel":200,"taxiFuel":4,"volumeUnit":"l","equipmentCodes":"SDFGY","surveillanceCodes":"C","colourAndMarkings":"WHITE RED STRIPES"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft

PATCH /v1/aircraft/{id}

Update a aircraft. JSON Merge Patch of the profile. The registration rule holds; attachments are kept. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/aircraft/types.ts (AircraftProfile)

ParameterInDescription
idpath, requiredThe aircraft id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft/{id}

PUT /v1/aircraft/{id}

Replace a aircraft. Replaces the profile whole on the app’s blank one; attachments are kept. If-Match makes it conditional.

Fields: src/core/aircraft/types.ts (AircraftProfile)

ParameterInDescription
idpath, requiredThe aircraft id.

Needs a key allowed to write.

curl -X PUT -H "Content-Type: application/json" -d '{"registration":"LV-ABC","icaoType":"C172","category":"singleEnginePiston","wakeTurbulence":"L","cruiseTas":105,"cruiseFuelBurn":32,"usableFuel":200,"taxiFuel":4,"volumeUnit":"l","equipmentCodes":"SDFGY","surveillanceCodes":"C","colourAndMarkings":"WHITE RED STRIPES"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft/{id}

DELETE /v1/aircraft/{id}

Delete a aircraft. Deletes the aircraft and, as the app does, its checklists (alsoDeleted), each with a tombstone. Its files stay in the pilot’s storage until deleted from the app. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/aircraft/types.ts (AircraftProfile)

ParameterInDescription
idpath, requiredThe aircraft id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft/{id}

Weather

GET /v1/weather

Weather at the pilot’s aerodromes. Latest METAR and TAF, raw and decoded, for every aerodrome on a card or on the weather briefing. Each entry has a status — ok, no_report, no_icao_indicator or unavailable — and nothing is filled in when a report is absent. Source: NOAA Aviation Weather Center, cached for up to five minutes.

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/weather

GET /v1/weather/{ident}

Weather at one aerodrome. Any four-letter ICAO location indicator, whether or not it is on a card. A three-letter national code answers no_icao_indicator.

ParameterInDescription
identpath, requiredICAO location indicator, e.g. SAEZ.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/weather/{ident}

Notes

GET /v1/notes

Flight notes. Every note — the kneeboard — with every field, including a handwritten note’s image as a data URL. Newest first by last change.

Fields: src/core/notes/types.ts (FlightNote)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes

GET /v1/notes/{id}

One note. By note id.

Fields: src/core/notes/types.ts (FlightNote)

ParameterInDescription
idpath, requiredThe note id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes/{id}

POST /v1/notes

Create a note. A kneeboard note: title, body, kind (general, atis, clearance, traffic, frequency, fuel), optionally a PNG imageDataUrl, an aircraftId and a logbook flightId of this account. A blank note is refused — the app discards one. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/notes/types.ts (FlightNote)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"kind":"atis","title":"SADF ATIS","body":"INFO BRAVO RWY 05 WIND 040/08 QNH 1015"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes

PATCH /v1/notes/{id}

Update a note. JSON Merge Patch of the note. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/notes/types.ts (FlightNote)

ParameterInDescription
idpath, requiredThe note id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes/{id}

PUT /v1/notes/{id}

Replace a note. Replaces the note whole. If-Match makes it conditional.

Fields: src/core/notes/types.ts (FlightNote)

ParameterInDescription
idpath, requiredThe note id.

Needs a key allowed to write.

curl -X PUT -H "Content-Type: application/json" -d '{"kind":"atis","title":"SADF ATIS","body":"INFO BRAVO RWY 05 WIND 040/08 QNH 1015"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes/{id}

DELETE /v1/notes/{id}

Delete a note. Deletes the note with a tombstone. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/notes/types.ts (FlightNote)

ParameterInDescription
idpath, requiredThe note id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notes/{id}

Flight plans

GET /v1/flight-plans

Flight plans. Every ICAO flight plan with every field (items 7 to 19, the route, supplementary information). Newest departure date first.

Fields: src/core/flightplan/types.ts (FlightPlan)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans

GET /v1/flight-plans/{id}

One flight plan. By flight plan id.

Fields: src/core/flightplan/types.ts (FlightPlan)

ParameterInDescription
idpath, requiredThe flight plan id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{id}

GET /v1/plannings

Plannings. Every route the pilot planned on the map — the working before a flight plan: the points in order with their positions, the aircraft, the planned departure, altitude, fuel on board, reserve and wind choice, and the flight plan it became (flightPlanId). Stored as the route entity; departure, destination and waypoints mirror points. Newest change first.

Fields: src/core/planning/types.ts (RoutePlanning)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings

GET /v1/plannings/{id}

One planning. By planning id.

Fields: src/core/planning/types.ts (RoutePlanning)

ParameterInDescription
idpath, requiredThe planning id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{id}

GET /v1/shared-plannings

Shared plannings. Plannings this pilot plans together with copilots — as the owner, or as a guest who accepted. Up to four pilots: the owner and three guests, each guest a viewer or an editor (participants[].access; the caller’s own in access). One document the owner and the editors edit (doc: the route, alternates, time, level, rules, wind), each pilot’s own half under participants[].personal (aircraft, speed, burn, fuel) with a summary of the aircraft each chose. Never the owner’s provider keys. Newest change first.

Fields: src/core/planning/shared.ts (SharedPlanning)

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/shared-plannings

GET /v1/shared-plannings/{id}

One shared planning. By id. Not found unless this pilot is its owner or one of its accepted guests.

Fields: src/core/planning/shared.ts (SharedPlanning)

ParameterInDescription
idpath, requiredThe shared planning id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/shared-plannings/{id}

POST /v1/plannings

Create a planning. A planning — the route built on the map — from departure, route and destination: each element an identifier the app’s lookup places (aerodrome, navaid, ENR 4.4 fix; {ident, kind} where a code names two), {airway, to} along an AIP ATS route (every published point added; refused when the route does not join them), or {lat, lon, name}. Plus alternates, aircraft, off-block time, level, TAS, burn, fuel on board, reserve, rules and wind. An identifier nobody knows is refused, never guessed. Checked by the same validators as a shared planning. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/planning/types.ts (RoutePlanning)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"name":"San Fernando – Rosario","departure":"SADF","route":[{"ident":"FDO","kind":"navaid"},{"airway":"W5","to":"ROS"}],"destination":"SAAR","alternates":["SAAV"],"aircraftId":"3f0c2b6e-8a1d-4c55-9e0a-2d7b6f1c9a40","departureAt":"2026-10-10T13:00:00Z","cruiseAltitudeFt":4500,"flightRules":"V","fuelAtDeparture":150,"reserveMinutes":45,"windSource":"manual","manualWind":{"fromTrueDeg":270,"speedKt":15}}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings

PATCH /v1/plannings/{id}

Update a planning. JSON Merge Patch. Sending departure, route or destination rebuilds the points (the others kept); points replaces them whole. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/planning/types.ts (RoutePlanning)

ParameterInDescription
idpath, requiredThe planning id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{id}

DELETE /v1/plannings/{id}

Delete a planning. Deletes the planning with a tombstone. A flight plan made from it stays. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/planning/types.ts (RoutePlanning)

ParameterInDescription
idpath, requiredThe planning id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{id}

GET /v1/plannings/{id}/navlog

A planning’s navigation log. Computed, never stored, by the app’s own buildNavlog: per leg distance, true and magnetic track (declination at the leg, as the pilot’s setting says), heading, wind correction, ground speed, time, fuel, fuel remaining, ETA and the legal levels; totals, trip fuel, reserve, minimum fuel, endurance, the alternate leg and fuelStatus. Without a TAS there are no times, without a burn no fuel, without fuel on board no remaining fuel — missing names what would unlock them. A forecast wind is not fetched by the API (wind.applied: false); use manual or none.

Fields: src/core/planning/navlog.ts (Navlog)

ParameterInDescription
idpath, requiredThe planning id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{id}/navlog

POST /v1/plannings/{id}/flight-plan

Make the ICAO flight plan from a planning. The panel’s “Create flight plan”: planningToFlightPlan from the planning and its log (aerodromes or ZZZZ with DEP//DEST//ALTN/, field 15 filing an airway run as entry–designator–exit, speed, level, EET, endurance, DOF/), the pilot’s NAV/ OPR/ PER/, and the planning keeps the link (flightPlanId). 201 with the plan as a **draft** and its validation. No body needed; Idempotency-Key (or a body id) makes a retry land on the same plan. Two writes.

Fields: src/core/flightplan/types.ts (FlightPlan)

ParameterInDescription
idpath, requiredThe planning id.

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plannings/{id}/flight-plan

POST /v1/flight-plans

Create a flight plan. An ICAO flight plan straight from fields, built as the assistant builds one (draftToFlightPlan): aerodromes resolved to their indicators, field 15 as chips, the profile’s prefill from aircraftId, departureAt into field 13 and DOF/, the level from cruiseAltitudeFt at the pilot’s transition altitude, reuseFrom an earlier plan’s standing details, the pilot’s NAV/ OPR/ PER/; then every other field 7–19 through the app’s own applyFlightPlanPatch. Answers with validation — the app’s own validator for the pilot’s region (validateForArgentina), every issue with its ICAO field, severity, catalogue key and English text — and the rendered FPL message. status: "filed" is refused while an error remains. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/flightplan/types.ts (FlightPlan)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"aircraftId":"3f0c2b6e-8a1d-4c55-9e0a-2d7b6f1c9a40","departureAerodrome":"SADF","destinationAerodrome":"SAAR","alternateAerodrome":"SAAV","departureAt":"2026-10-10T13:00:00Z","route":"DCT FDO W5 ROS DCT","cruiseAltitudeFt":4500,"totalEet":"0120","supplementary":{"personsOnBoard":2,"endurance":"0430"}}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans

PATCH /v1/flight-plans/{id}

Update a flight plan. Field by field through applyFlightPlanPatch; route replaces field 15; departureAt moves 13 and DOF/ together; status closes it (filed only without errors). A plan whose flight has been and gone is read-only, as in the app: only its date (which revives it) or a status of flown/cancelled. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/flightplan/types.ts (FlightPlan)

ParameterInDescription
idpath, requiredThe flight plan id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{id}

DELETE /v1/flight-plans/{id}

Delete a flight plan. Deletes the plan with a tombstone. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/flightplan/types.ts (FlightPlan)

ParameterInDescription
idpath, requiredThe flight plan id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{id}

GET /v1/flight-plans/{id}/validation

Validate a flight plan as the app does. The app’s own validator for the pilot’s operating region (validateForArgentina for AR, else validateFlightPlan): filable, every issue (field — the ICAO field number —, severity, code — the catalogue key —, message in English, values), the display status (draft, filed, expired, flown, cancelled), whether it is still editable, when it expires, and the (FPL-…) message as filed.

Fields: src/core/flightplan/icao.ts (ValidationIssue)

ParameterInDescription
idpath, requiredThe flight plan id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plans/{id}/validation

Logbook

GET /v1/logbook

Logbook entries. Every flight in the logbook, with every field; the ANAC logbook line is under log. Newest first by flight date. Durations are whole minutes.

Fields: src/services/storage/db.ts (FlightLog) and src/core/logbook/entry.ts (LogbookEntry)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook

GET /v1/logbook/totals

Logbook totals. Sums over every entry, in whole minutes, computed by the same function the app uses. The breakdown cells are never added to the flight total. Optional from / to dates bound the flights counted.

ParameterInDescription
fromqueryFirst flight date counted, YYYY-MM-DD, inclusive.
toqueryLast flight date counted, YYYY-MM-DD, inclusive.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/totals

GET /v1/logbook/export

The logbook as a CSV file. The logbook as the Logbook screen exports it, by the same function (src/core/logbook/export.ts): anac-cad (ANAC’s sheet column for column, in the CAD form’s order — ANAC publishes no CAD import format), easa (AMC1 FCL.050), foreflight (ForeFlight’s import template) or generic-full (every field, lossless). Oldest first. Answers text/csv with a UTF-8 byte order mark (none for foreflight), not JSON.

Fields: src/core/logbook/export.ts (ANAC_COLUMNS, EASA_COLUMNS, FOREFLIGHT_FLIGHT_COLUMNS, FULL_COLUMNS)

ParameterInDescription
formatquery, requiredanac-cad, easa, foreflight or generic-full.
fromqueryFirst flight date, YYYY-MM-DD, inclusive.
toqueryLast flight date, YYYY-MM-DD, inclusive.
zonequeryIANA zone the anac-cad clock times are written in (America/Argentina/Buenos_Aires). Default UTC; EASA and ForeFlight are always UTC.
delimiterquerysemicolon (decimal comma; Excel in Spanish — the default for anac-cad) or comma. ForeFlight is always comma.
totalsquerytrue adds a totals line (not for foreflight). Default false.
dateFormatquerydmy (default) or mdy, for the anac-cad and easa dates. The others are ISO.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/export

GET /v1/logbook/{id}

One logbook entry. By entry id.

Fields: src/services/storage/db.ts (FlightLog)

ParameterInDescription
idpath, requiredThe logbook entry id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/{id}

GET /v1/logbook/{id}/attachments/{attachmentId}

Download link for a photo on a logbook entry. A photo the pilot attached to the flight (listed in the entry’s attachments). Returns the attachment’s metadata and a presigned HTTPS URL to the file itself, valid for 15 minutes; fetch it without the API key. 404 when the entry does not name that attachment, or its file has not been uploaded yet. Deleting the entry deletes its photos.

Fields: src/core/files/attachments.ts (Attachment)

ParameterInDescription
idpath, requiredThe logbook entry id.
attachmentIdpath, requiredThe id of one entry in the logbook entry’s attachments.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/{id}/attachments/{attachmentId}

POST /v1/logbook

Create a logbook entry. Adds hours: one ANAC logbook line (LogbookEntry), stored as the log of a flight built by the same function the Logbook screen uses, so GET /v1/logbook/totals counts it at once. Refused (422) with no date, an arrival before the departure, or a value outside ANAC’s lists; stored **with** warnings where the app stores with warnings (no time, a breakdown over the total, hood time without a safety pilot). Durations in whole minutes or "1:45"/"1.75". Sent with off- and on-blocks and no times, the block time fills the cell its kind, role and night imply, as the dialog does. The aircraft is aircraftId, or the profile whose registration matches. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/logbook/entry.ts (LogbookEntry), stored as the `log` of a flight (src/services/storage/db.ts, FlightLog)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"date":"2026-10-09","departureAt":"2026-10-09T13:05:00Z","arrivalAt":"2026-10-09T14:55:00Z","departureAerodrome":"SADF","arrivalAerodrome":"SAAR","kind":"crossCountry","role":"pilot","registration":"LV-ABC","purpose":"VP","landings":1,"remarks":"Travesía a Rosario"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook

PATCH /v1/logbook/{id}

Update a logbook entry. Changes the line: the body is a JSON Merge Patch of the LogbookEntry ({"landings": 2}, {"times": {"localNightPilot": 30}}). The flight’s own fields follow the line. Validated and warned as on create. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/logbook/entry.ts (LogbookEntry), stored as the `log` of a flight (src/services/storage/db.ts, FlightLog)

ParameterInDescription
idpath, requiredThe logbook entry id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/{id}

PUT /v1/logbook/{id}

Replace a logbook entry. Replaces the line whole; the flight’s own fields follow it. If-Match makes it conditional.

Fields: src/core/logbook/entry.ts (LogbookEntry), stored as the `log` of a flight (src/services/storage/db.ts, FlightLog)

ParameterInDescription
idpath, requiredThe logbook entry id.

Needs a key allowed to write.

curl -X PUT -H "Content-Type: application/json" -d '{"date":"2026-10-09","departureAt":"2026-10-09T13:05:00Z","arrivalAt":"2026-10-09T14:55:00Z","departureAerodrome":"SADF","arrivalAerodrome":"SAAR","kind":"crossCountry","role":"pilot","registration":"LV-ABC","purpose":"VP","landings":1,"remarks":"Travesía a Rosario"}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/{id}

DELETE /v1/logbook/{id}

Delete a logbook entry. Deletes the entry with a tombstone, so every device deletes it too; the totals stop counting it. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/logbook/entry.ts (LogbookEntry), stored as the `log` of a flight (src/services/storage/db.ts, FlightLog)

ParameterInDescription
idpath, requiredThe logbook entry id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/logbook/{id}

Checklists

GET /v1/checklists

Checklists. Every checklist the pilot built, with its sections and items, for every aircraft. Sorted by aircraft, then by the pilot’s own order. Filter with aircraftId.

Fields: src/core/checklists/types.ts (Checklist)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
aircraftIdqueryOnly the checklists of this aircraft.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists

GET /v1/checklists/{id}

One checklist. By checklist id.

Fields: src/core/checklists/types.ts (Checklist)

ParameterInDescription
idpath, requiredThe checklist id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists/{id}

GET /v1/check-flights

Flight checks. One record per flight the pilot ran an aircraft’s checklists on: when it started and finished, the lists in that day’s order, and a summary — items total, items done, and every item left unchecked. Newest first. Filter with aircraftId.

Fields: src/core/checklists/checkFlight.ts (CheckFlight)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
aircraftIdqueryOnly the flights of this aircraft.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/check-flights

GET /v1/check-flights/{id}

One flight’s checks. By flight id.

Fields: src/core/checklists/checkFlight.ts (CheckFlight)

ParameterInDescription
idpath, requiredThe flight id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/check-flights/{id}

POST /v1/checklists

Create a checklist. A checklist of one of the pilot’s aircraft (aircraftId), with name, kind and sections[].items[] (challenge, response, type, critical…); ids are made where the body has none. Last in the aircraft’s order unless order says. The content is the pilot’s, from their aircraft’s documentation — the app ships none. 201 with the record and its ETag; send Idempotency-Key (or a UUID id) and a retry answers 200 with the stored record (Idempotent-Replayed: true).

Fields: src/core/checklists/types.ts (Checklist)

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"aircraftId":"3f0c2b6e-8a1d-4c55-9e0a-2d7b6f1c9a40","name":"Before take-off","kind":"normal","sections":[{"title":"Run-up","items":[{"challenge":"Magnetos","response":"Checked","type":"challengeResponse","critical":true},{"challenge":"Flight controls","response":"Free and correct","type":"challengeResponse"}]}]}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists

PATCH /v1/checklists/{id}

Update a checklist. JSON Merge Patch; sections replaces whole. If-Match: "<updatedAt>" makes it conditional (412).

Fields: src/core/checklists/types.ts (Checklist)

ParameterInDescription
idpath, requiredThe checklist id.

Needs a key allowed to write.

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists/{id}

PUT /v1/checklists/{id}

Replace a checklist. Replaces the checklist whole. If-Match makes it conditional.

Fields: src/core/checklists/types.ts (Checklist)

ParameterInDescription
idpath, requiredThe checklist id.

Needs a key allowed to write.

curl -X PUT -H "Content-Type: application/json" -d '{"aircraftId":"3f0c2b6e-8a1d-4c55-9e0a-2d7b6f1c9a40","name":"Before take-off","kind":"normal","sections":[{"title":"Run-up","items":[{"challenge":"Magnetos","response":"Checked","type":"challengeResponse","critical":true},{"challenge":"Flight controls","response":"Free and correct","type":"challengeResponse"}]}]}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists/{id}

DELETE /v1/checklists/{id}

Delete a checklist. Deletes the checklist with a tombstone. 200 { id, deleted: true, alsoDeleted }, the same on a retry; 404 if it never existed.

Fields: src/core/checklists/types.ts (Checklist)

ParameterInDescription
idpath, requiredThe checklist id.

Needs a key allowed to write.

curl -X DELETE -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/checklists/{id}

Ground school

GET /v1/ground-school

The theory path and where the pilot is in it. Every lesson of the ground school in path order — id, level, subject, titles in English and Spanish, whether it has content, what it builds on — with the pilot’s status, dates, the step they are on and each exercise’s best score. next is the lesson the app offers to continue or start. Study time and study days are not returned.

Fields: src/core/groundSchool/apiView.ts (GroundSchoolApiView)

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/ground-school

Transit sessions

GET /v1/transit-plans

Transit session plans. The instructed transit sessions the pilot authored in Copilot EFB, most recently edited first: the aircraft, the flight rules, departure and destination, the steps in order (each an action, who gives it, how it ends, holds, minima and targets) and the emergency and position-request settings. RogerATC reads the armed one and validates it with its mirror of normaliseTransitPlan. Read-only: plans are written in the app.

Fields: src/core/transit/plan.ts (TransitPlan)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/transit-plans

GET /v1/transit-plans/{id}

One transit session plan. By plan id — the planId the live answer’s transit names. 404 once the pilot deleted it.

Fields: src/core/transit/plan.ts (TransitPlan)

ParameterInDescription
idpath, requiredThe plan id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/transit-plans/{id}

GET /v1/transit-runs

Transit session runs. Every execution of a transit plan the plugin reported, newest first: status, progress per step with what was said and what was measured, the emergencies and position requests, and the session’s transcript. updatedSince follows a run in progress.

Fields: src/core/transit/run.ts (TransitRun)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/transit-runs

GET /v1/transit-runs/{id}

One transit session run. By run id. What the plugin reads to resume a session after X-Plane closed: the arm still names the run, and currentStepIndex is the step to give again.

Fields: src/core/transit/run.ts (TransitRun)

ParameterInDescription
idpath, requiredThe run id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/transit-runs/{id}

RogerATC plugin

POST /v1/plugin/activation

Activate RogerATC. The beta’s licence check. The plugin calls it once at every start (client: "core") and RogerATC Setup when the pilot links or tests the key (client: "setup"). Answers who the account is and **the names** of the provider keys the pilot holds in Copilot EFB — never their values. Records the installation (version, OS, X-Plane version, settings) and, for core, a launch on today’s counter; nothing synced. 403 account_suspended when an administrator has paused the account. Body at most 8 KB; unknown fields are ignored.

Fields: src/core/plugin/activation.ts (PluginActivationRequest)

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/activation

GET /v1/plugin/credentials

Provider keys for RogerATC. The provider keys RogerATC uses, as the pilot entered them in Copilot EFB (Settings): openai, openaip, windy, flightradar24, tavily, anthropic, xai, openrouter — only the ones present. Served with Cache-Control: no-store. The server records when they were fetched and which names it returned, never a value, and never logs one. 403 account_suspended when the account is paused. 403 credentials_disabled (1.28.0) when the pilot turned off “RogerATC may read my provider keys” in Settings → API — the key still works everywhere else.

Fields: src/core/plugin/activation.ts (PLUGIN_CREDENTIALS)

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/credentials

PUT /v1/plugin/sessions/{id}

Store a plugin session. An idempotent upsert of one whole RogerATC session: send it at the start, at checkpoints, and at the end, under the same id. Answers 201 the first time and 200 after. 410 gone when the pilot deleted the session in the app — stop sending it. Oldest events are dropped to fit the limits, and eventsDropped says how many. Since 1.17.0 an optional aiUsage array — the session’s cumulative AI usage, one line per provider, model and kind, at most 40 — feeds the pilot’s AI usage counters with the difference from the stored copy, so a re-send counts nothing.

Fields: src/core/plugin/session.ts (PluginSession)

ParameterInDescription
idpath, requiredThe plugin’s session id, stable for the flight: 3–128 of A–Z a–z 0–9 . _ -.
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/sessions/{id}

PUT /v1/plugin/live

Report live state, collect commands. The live link, polled by the plugin while the simulator runs. Since 1.38.0 the answer also carries transit: the armed transit session (planId, armedAt, runId) or null. Since 1.48.0 the report may carry linkVersion (2: commands that arrive during a pause are held and acknowledged held, then answered after it) and the answer carries cancel, the held commands the pilot withdrew. The body is the plugin’s current state — position, phase, radios, the pilot’s altimeter setting, the aircraft’s configuration, weather and wind layers as the simulator has it, the simulator’s own TCAS traffic (positions only), the controller’s last procedure — and the outcome (acks) of every command it dealt with since the last call. The answer carries the commands the pilot sent from the app and the plugin has not collected yet, oldest first, each handed over exactly once, and pollMs: 2000 while somebody has the RogerATC screen open, 10000 while nobody does. Always 200. The report replaces the previous one and expires after ten minutes; it is never a track and never a synced record. No navigation data: the plugin sends where the aeroplane is, never what is near it. Body at most 32 KB.

Fields: src/core/plugin/live.ts (LiveReport, CommandRequest)

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/live

PUT /v1/plugin/transit-runs/{id}

Store a transit session run. An idempotent upsert of one whole run of a transit plan: at the start, every time a step moves, and at the end, under the same id. 201 the first time, 200 after. A **new** run is accepted only for the plan the pilot armed (the live answer’s transit), otherwise 409 not_armed; the first PUT names the run on the arm, every PUT in progress renews it, and completed or aborted clears it. 410 gone when the pilot deleted the run or its plan — stop the session. 429 past 20 new runs a day; re-sending one is free. Oldest transcript lines are dropped past 600 and counted in transcriptDropped. Body at most 400 KB.

Fields: src/core/transit/run.ts (TransitRun)

ParameterInDescription
idpath, requiredThe run id, stable for the session: 3–128 of A–Z a–z 0–9 . _ -.
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/transit-runs/{id}

GET /v1/plugin/sessions

Plugin sessions. Every RogerATC session stored for the account, newest first, with its statistics and events. updatedSince follows sessions still in progress.

Fields: src/core/plugin/session.ts (PluginSession)

ParameterInDescription
limitqueryRecords per page, 1–200. Default 50. A page may hold fewer when records are large.
cursorqueryOpaque. Pass page.nextCursor from the previous response to get the next page.
updatedSincequeryISO 8601 date-time. Only records changed after it — the way to follow changes.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/sessions

GET /v1/plugin/sessions/{id}

One plugin session. By session id.

Fields: src/core/plugin/session.ts (PluginSession)

ParameterInDescription
idpath, requiredThe plugin’s session id.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/sessions/{id}

GET /v1/plugin/stats

Plugin totals. Totals over every stored session — the same function the app’s RogerATC screen uses: sessions by status, minutes, transmissions, readbacks, response time, stations, aerodromes and aircraft.

Fields: src/core/plugin/session.ts (PluginTotals)

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/stats

GET /v1/plugin/messages

Unread messages. The pilot’s **unread inbox** messages — from a copilot or the administrator — for RogerATC’s instructor to read aloud, oldest first, at most limit. Each carries its record id (to mark it read), from (the sender’s name, else the part of their email before @, else Copilot EFB — never the address), fromAdministrator, broadcast, subject (absent when there is none), body (at most 1000 characters; a longer one is cut at a word and ends with …) and sentAt. unread is the total unread, which may exceed what data holds. Served with Cache-Control: no-store. Sent copies, threads and recipients are not in the API.

Fields: src/core/plugin/messages.ts (PluginMessagesResponse)

ParameterInDescription
limitqueryMessages to return, 1–20. Default 10.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/messages

POST /v1/plugin/messages/{id}/read

Mark a message read. Marks one inbox message read, exactly as opening it in the app would: readAt is set and the record moves forward in sync, so every one of the pilot’s devices pulls it as read. 204 with no body, also when it was read already; 404 when the id is not an inbox message of this account. The body is ignored. Nothing else about the message can be changed here.

ParameterInDescription
idpath, requiredThe id from GET /v1/plugin/messages.
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/messages/{id}/read

GET /v1/plugin/feedback

Turn ratings, as a training dataset. An **administrator’s** ratings of RogerATC turns, made in the app on the transcript of a live or archived session, as the dataset the plugin’s next version learns from. Each example is one turn — the pilot transmission and every answer to it, copied when it was rated — with what was going on (context: aerodrome, station, position, the intent and template the plugin recognised), the rating (up: keep doing exactly this; down: correction says what should have happened, which layer failed and how far the lesson carries) and, when asked for, a model’s review of the correction with its sources and where the fix belongs. guidance says how to read it. Only an administrator’s account holds any; anybody else gets an empty dataset. Served with Cache-Control: no-store.

Fields: src/core/plugin/feedback.ts (FeedbackDataset)

ParameterInDescription
statusquerypending (default): not yet taken into a version. applied, or all.
curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/feedback

POST /v1/plugin/feedback/applied

Mark turn ratings applied. Marks ratings as taken into a plugin version, by the id of each example (<sessionId>:<turnKey>), with the version and an optional note on what changed. They leave the pending dataset and expire 90 days later. An id that is not a rating of this account is skipped; marked says how many were. Needs a key allowed to write.

Needs a key allowed to write.

curl -X POST -H "Content-Type: application/json" -d '{"ids":["ses_01J9Z3K:0a1b2c3d4e5f6071"],"version":"1.6.0-beta","note":"Taxi phrasing at uncontrolled fields."}' -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/feedback/applied

Pilot

GET /v1/pilot

Pilot profile. The pilot profile with every field: name, telephone, licences, ratings with their expiry, the medical certificate. data is null when the pilot has not created one. The key grants this; treat it accordingly.

Fields: src/core/flightplan/types.ts (PilotProfile) and src/core/pilot/credentials.ts

curl -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/pilot