Skip to content

AGENTS.md

This page is written for autonomous coding agents (LLMs, retrieval agents, or developer tools that ground answers in this site). Humans are welcome too, but it's terser than the rest of the documentation by design.

Three places to look

You want... Fetch
A machine-friendly index of every page llms.txt
The exact signature, parameter, return type of a member api-md/<full-uid>.md
All useful pages concatenated into one document llms-full.txt
A topical answer or a working snippet the rendered guide pages (getting-started/, samples/csharp/, ...), or the same content inside llms-full.txt

URL conventions

  • The site is versioned: each release is a snapshot under /<version>/, and the paths above live at each version root. Start from https://api.sidrasolutions.com/latest/llms.txt (or swap latest for a specific version) and resolve its relative links from there.
  • Domain-root probes also work in production: /llms.txt, /llms-full.txt and /api-md/* redirect (302) to their /latest/ equivalents.
  • Every public type maps to api-md/<full-uid>.md. Example: SIDRASolutions.SI.API.ISIAPILaneMovement → api-md/sidrasolutions.si.api.isiapilanemovement.md. UIDs are lowercased; no other transformation.
  • Members live in the same file as their owning type, not on separate pages. Use anchor links: api-md/sidrasolutions.si.api.isiapi.md#openproject.
  • Every api-md/ file has YAML frontmatter with uid, name, type, namespace, a members list, and (when the source XML docs provide one) a summary: parse these before reading prose.

What the API actually is

  • A .NET 8 COM-visible assembly: SIDRASolutions.SI.API.
  • Root activation interface: ISIAPI (Type.GetTypeFromProgID("SIDRASolutions.SI.API")).
  • Object model is tree-shaped: Project &rarr; Site &rarr; Intersection &rarr; Leg &rarr; LaneMovement.
  • See Object model for the full hierarchy and naming conventions (I... singular, I...s plural, ..._<variant> for parameter-set variants, ...MC for movement-class-specific types).
  • x64 only. STA threading required.

Heuristics for retrieval

  • "How do I do X?" → start with /getting-started.md and /samples/csharp.md.
  • "What does method/property X do?" → find the owning type in /api-md/.
  • "How are sites and networks related?" → /concepts/object-model.md.

What is not on this site

  • Behavioural specifics of the traffic-engineering models (HCM, roundabout capacity, gap acceptance). The API exposes inputs and outputs; the modelling itself is documented in the SIDRA Intersection User Guide, shipped with the product.
  • Licensing, install, and activation of SIDRA Intersection itself. See the product's installer and licence portal.