# Ontime APIs {% hint style="info" %} Ontime has a strong focus on integrations. We want ontime to play well into your workflow. Have an idea of how could this be better? Let's chat! Get in touch on email [mail@getontime.no ]()or [open an issue in GitHub](https://github.com/cpvalente/ontime/issues) {% endhint %} We would like you to [build your own views ](https://ontime.gitbook.io/v2/features/make-your-own-viewer)and your own controllers, and let Ontime handle the distribution and time-keeping The Ontime app window, as well as the editor page, communicate with ontime through an open API. You can leverage this API yourself to extend the feature set or integrate into your workflow The OSC and Websocket API allow for low latency communication to ontime server. Both APIs are identical, so it is up to you to choose the most convenient protocol The [HTTP API ](https://ontime.gitbook.io/v2/control-and-feedback/ontime-apis/http-api)has access to a smaller subset of features ### OSC and WebSocket API {% hint style="info" %} Maybe you know your way around code? That is the best and most up-to-date source! {% endhint %} | Message | Payload | Description | Return | | -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | test-ontime | | | "hello" | | ontime-poll | | Returns the entire runtime state | { topic: "poll", payload: [\](https://ontime.gitbook.io/v2/control-and-feedback/runtime-data) } | | set-onair | "false" \| "true" \| undefined | Sets on air to given value, toggle if none is given | | | onair | | Set on air to **true** | | | offair | | Set on air to **false** | | | set-timer-message-text | string | Sets text of timer message | | | set-timer-message-visible | "false" \| "true" \| undefined | Sets visibility to given value, toggle if none is given | | | set-public-message-text | string | Sets text of public message | | | set-public-message-visible | "false" \| "true" \| undefined | Sets visibility to given value, toggle if none is given | | | set-lower-message-text | string | Sets text of lower message | | | set-lower-message-visible | "false" \| "true" \| undefined | Sets visibility to given value, toggle if none is given | | | start | | Starts selected timer | | | start-next | | Loads and starts next timer in rundown | | | startindex | number | Loads and starts event at index (first event is 1) | | | startid | string | Loads and starts event with given ID | | | startcue | string | Loads and starts event with given cue | | | pause | | Pauses playback | | | previous | | Loads previous event | | | next | | Loads next event | | | stop | | Stops playback | | | reload | | Reloads selected event | | | roll | | Sets playback mode to roll | | | delay | number | Adds a delay of given time to a playing event | | | loadindex | number | Loads event at given index (first event is 1) | | | loadid | number | Loads event at given ID | | | loadcue | string | Loads event with given cue | | | get-playback | | Returns playback portion [Runtime Data](https://ontime.gitbook.io/v2/control-and-feedback/runtime-data) | {topic: "playback", payload: \} | | get-timer | | Returns timer portion [Runtime Data](https://ontime.gitbook.io/v2/control-and-feedback/runtime-data) | {topic: "timer", payload: \} | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ontime.gitbook.io/v2/control-and-feedback/ontime-apis.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.