> For the complete documentation index, see [llms.txt](https://docs.sygnal.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sygnal.network/specification/api-reference.md). # OpenAPI reference The rendered OpenAPI 3.1 reference for the Sygnal coordination APIs (v0.9 public draft). The authoritative definition of the Sygnal APIs is the OpenAPI 3.1 document [`specs/sygnal-coordination-apis.yaml`](https://github.com/Medtronic-LABS/sygnal/blob/main/specs/sygnal-coordination-apis.yaml). [Download the raw file](https://raw.githubusercontent.com/Medtronic-LABS/sygnal/main/specs/sygnal-coordination-apis.yaml). ## Validate it yourself ```bash pip install pyyaml openapi-spec-validator jsonschema rfc3987 python3 specs/tools/validate.py specs/sygnal-coordination-apis.yaml ``` The validator checks: * YAML well-formedness, including duplicate keys; * OpenAPI 3.1 structure and `$ref` resolution; * every schema example against its schema (JSON Schema 2020-12, with formats asserted); * a request envelope built for each of the 14 paths; * trust alignment with Beckn v2 core; * positive and negative cases for the policy and reporting rules. ## Operations {% openapi src="" path="/sygnal/deviation/flag" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/deviation/on\_flag" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/event/report" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/policy/update" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/policy/on\_update" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/plan/sync" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/plan/on\_sync" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/signal/emit" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/policy/get" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/policy/on\_get" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/deviation/get" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/deviation/on\_get" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/plan/get" method="post" %} {% endopenapi %} {% openapi src="" path="/sygnal/plan/on\_get" method="post" %} {% endopenapi %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.sygnal.network/specification/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.