# Developer Portal ## Developer Portal - [Portal overview](https://developer.singular.live/portal-overview.md): An introduction to the Singular Developer Portal - [Quick start](https://developer.singular.live/quick-start.md): Control your first Singular graphic with the REST API - [Introduction](https://developer.singular.live/rest-api/introduction.md): An overview of the REST API documentation - [Rate limits](https://developer.singular.live/rest-api/rate-limits.md) - [Authorization](https://developer.singular.live/rest-api/authorization.md) - [How-to guides](https://developer.singular.live/rest-api/how-to-guides.md): Learn how to accomplish common tasks with the Singular REST API - [Get a control app's API token](https://developer.singular.live/rest-api/how-to-guides/get-a-control-apps-api-token.md) - [Get a composition's sub-composition IDs and names and their payload structures](https://developer.singular.live/rest-api/how-to-guides/get-a-compositions-sub-composition-ids-and-names-and-their-payload-structures.md) - [Get a control app's model](https://developer.singular.live/rest-api/how-to-guides/get-a-control-apps-model.md) - [Get a control app's metadata](https://developer.singular.live/rest-api/how-to-guides/get-a-control-apps-metadata.md) - [Update a sub-composition's content](https://developer.singular.live/rest-api/how-to-guides/update-a-sub-compositions-content.md) - [Update a sub-composition's animation state](https://developer.singular.live/rest-api/how-to-guides/update-a-sub-compositions-animation-state.md) - [Update a sub-composition's content and animation state in one call](https://developer.singular.live/rest-api/how-to-guides/update-a-sub-compositions-content-and-animation-state-in-one-call.md) - [Update multiple sub-compositions in one call](https://developer.singular.live/rest-api/how-to-guides/update-multiple-sub-compositions-in-one-call.md) - [API reference](https://developer.singular.live/rest-api/api-reference.md) - [Get control app details](https://developer.singular.live/rest-api/api-reference/get-control-app-details.md) - [Get a control app's metadata](https://developer.singular.live/rest-api/api-reference/get-control-app-details/get-a-control-apps-metadata.md) - [Get a control app's model](https://developer.singular.live/rest-api/api-reference/get-control-app-details/get-a-control-apps-model.md) - [Get a control app's control data](https://developer.singular.live/rest-api/api-reference/get-control-app-details/get-a-control-apps-control-data.md) - [Send data to a control app](https://developer.singular.live/rest-api/api-reference/send-data-to-a-control-app.md) - [Update a control app's content](https://developer.singular.live/rest-api/api-reference/send-data-to-a-control-app/update-a-control-apps-content.md) - [Update a control app's animation state](https://developer.singular.live/rest-api/api-reference/send-data-to-a-control-app/update-a-control-apps-animation-state.md) - [Take out all of an app's output](https://developer.singular.live/rest-api/api-reference/take-out-all-of-an-apps-output.md) - [Introduction](https://developer.singular.live/data-stream-api/introduction.md): A faster way to send data - [Rate limits](https://developer.singular.live/data-stream-api/rate-limits.md) - [Authorization](https://developer.singular.live/data-stream-api/authorization.md) - [How-to guides](https://developer.singular.live/data-stream-api/how-to-guides.md) - [Create a data stream](https://developer.singular.live/data-stream-api/how-to-guides/create-a-data-stream.md) - [Link a data stream to a composition](https://developer.singular.live/data-stream-api/how-to-guides/link-a-data-stream-to-a-composition.md) - [Send data to an app using the data stream API](https://developer.singular.live/data-stream-api/how-to-guides/send-data-to-an-app-using-the-data-stream-api.md) - [API reference](https://developer.singular.live/data-stream-api/api-reference.md) - [Introduction](https://developer.singular.live/composition-scripting/introduction.md): Composition scripting documentation overview - [Overview](https://developer.singular.live/composition-scripting/overview.md): An overview of composition scripting - [Quick start](https://developer.singular.live/composition-scripting/quick-start.md) - [Find sub-compositions and widgets](https://developer.singular.live/composition-scripting/quick-start/find-sub-compositions-and-widgets.md) - [Read and update control nodes](https://developer.singular.live/composition-scripting/quick-start/read-and-update-control-nodes.md) - [Set text widget text properties](https://developer.singular.live/composition-scripting/quick-start/set-text-widget-text-properties.md) - [Read and update widget properties](https://developer.singular.live/composition-scripting/quick-start/read-and-update-widget-properties.md) - [Read control nodes and update widget properties](https://developer.singular.live/composition-scripting/quick-start/read-control-nodes-and-update-widget-properties.md) - [Set image widget URL property](https://developer.singular.live/composition-scripting/quick-start/set-image-widget-url-property.md) - [Set table widget content property](https://developer.singular.live/composition-scripting/quick-start/set-table-widget-content-property.md) - [Cheat sheets](https://developer.singular.live/composition-scripting/cheat-sheets.md) - [Fundamentals](https://developer.singular.live/composition-scripting/cheat-sheets/fundamentals.md) - [Interactive overlays](https://developer.singular.live/composition-scripting/cheat-sheets/interactive-overlays.md) - [Adaptive overlays](https://developer.singular.live/composition-scripting/cheat-sheets/adaptive-overlays.md) - [Overlay SDK](https://developer.singular.live/composition-scripting/cheat-sheets/overlay-sdk.md) - [Best practices](https://developer.singular.live/composition-scripting/cheat-sheets/best-practices.md) - [Use cases](https://developer.singular.live/composition-scripting/use-cases.md) - [Read control nodes and generate HTML text](https://developer.singular.live/composition-scripting/use-cases/read-control-nodes-and-generate-html-text.md) - [Read control nodes, generate HTML text with background](https://developer.singular.live/composition-scripting/use-cases/read-control-nodes-generate-html-text-with-background.md) - [Text Ticker - Start ticker on "In" animation](https://developer.singular.live/composition-scripting/use-cases/text-ticker-start-ticker-on-in-animation.md) - [Composition script editor reference](https://developer.singular.live/composition-scripting/composition-script-editor-reference.md): Get to know the composition script editor - [Graphics SDK](https://developer.singular.live/software-development-kits/graphics-sdk.md) - [Getting started](https://developer.singular.live/software-development-kits/graphics-sdk/getting-started.md) - [Reference](https://developer.singular.live/software-development-kits/graphics-sdk/reference.md) - [SDK functions](https://developer.singular.live/software-development-kits/graphics-sdk/reference/sdk-functions.md) - [Composition object](https://developer.singular.live/software-development-kits/graphics-sdk/reference/composition-object.md) - [Sequencer object](https://developer.singular.live/software-development-kits/graphics-sdk/reference/sequencer-object.md) - [Guides and examples](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples.md) - [Load a composition with its token](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/load-a-composition-with-its-token.md) - [Load a composition with its URL](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/load-a-composition-with-its-url.md) - [Get the composition URL of an app instance](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/get-the-composition-url-of-an-app-instance.md) - [Sequencer VOD example](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/sequencer-vod-example.md) - [Control local preview of app](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/control-local-preview-of-app.md) - [Load app instance output](https://developer.singular.live/software-development-kits/graphics-sdk/guides-and-examples/load-app-instance-output.md) - [Overlay SDK](https://developer.singular.live/software-development-kits/overlay-sdk.md) - [Getting started](https://developer.singular.live/software-development-kits/overlay-sdk/getting-started.md) - [SDK functions](https://developer.singular.live/software-development-kits/overlay-sdk/sdk-functions.md) - [Use case examples](https://developer.singular.live/software-development-kits/overlay-sdk/use-case-examples.md) - [Widget SDK](https://developer.singular.live/software-development-kits/widget-sdk.md) - [Preparing your environment](https://developer.singular.live/software-development-kits/widget-sdk/preparing-your-environment.md) - [Getting started](https://developer.singular.live/software-development-kits/widget-sdk/getting-started.md) - [Reference](https://developer.singular.live/software-development-kits/widget-sdk/reference.md) - [Widget UI definition](https://developer.singular.live/software-development-kits/widget-sdk/reference/widget-ui-definition.md) - [Widget callback functions](https://developer.singular.live/software-development-kits/widget-sdk/reference/widget-callback-functions.md) - [Time control object](https://developer.singular.live/software-development-kits/widget-sdk/reference/time-control-object.md) - [Composition instance](https://developer.singular.live/software-development-kits/widget-sdk/reference/composition-instance.md) - [Guides and examples](https://developer.singular.live/software-development-kits/widget-sdk/guides-and-examples.md) - [Widget example: CSS patterns](https://developer.singular.live/software-development-kits/widget-sdk/guides-and-examples/widget-example-css-patterns.md): This example widget lets users choose a pattern from a selection and define colors and spacing. - [App SDK](https://developer.singular.live/software-development-kits/app-sdk.md) - [Overview of Singular](https://developer.singular.live/singular-basics/overview-of-singular.md): Learn the basics of Singular - [Managing overlays in the Dashboard](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard.md): Stay organized with the Singular Dashboard. - [How to create a new composition](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/how-to-create-a-new-composition.md) - [How to open a new app template](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/how-to-open-a-new-app-template.md) - [How to create an app for a composition](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/how-to-create-an-app-for-a-composition.md) - [How to extract a composition from an app](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/how-to-extract-a-composition-from-an-app.md) - [How to find an app's shared app token and shared API URL](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/how-to-find-an-apps-shared-app-token-and-shared-api-url.md) - [Dashboard reference](https://developer.singular.live/singular-basics/managing-overlays-in-the-dashboard/dashboard-reference.md) - [Building overlays in Composer](https://developer.singular.live/singular-basics/building-overlays-in-composer.md): Take a deep dive into overlays and how to build them in Composer. - [How to build a composition](https://developer.singular.live/singular-basics/building-overlays-in-composer/how-to-build-a-composition.md) - [How to set up layer logic to automate overlay transitions](https://developer.singular.live/singular-basics/building-overlays-in-composer/how-to-set-up-layer-logic-to-automate-overlay-transitions.md) - [How to set up control nodes to make widget properties available to a control app](https://developer.singular.live/singular-basics/building-overlays-in-composer/how-to-set-up-control-nodes-to-make-widget-properties-available-to-a-control-app.md) - [Animating overlays](https://developer.singular.live/singular-basics/building-overlays-in-composer/animating-overlays.md) - [How to create timeline animations](https://developer.singular.live/singular-basics/building-overlays-in-composer/animating-overlays/how-to-create-timeline-animations.md) - [How to create behavior animations](https://developer.singular.live/singular-basics/building-overlays-in-composer/animating-overlays/how-to-create-behavior-animations.md) - [How to create update animations](https://developer.singular.live/singular-basics/building-overlays-in-composer/animating-overlays/how-to-create-update-animations.md) - [How to make overlays interactive](https://developer.singular.live/singular-basics/building-overlays-in-composer/how-to-make-overlays-interactive.md) - [How to adapt overlays to various screen sizes](https://developer.singular.live/singular-basics/building-overlays-in-composer/how-to-adapt-overlays-to-various-screen-sizes.md) - [Composer reference](https://developer.singular.live/singular-basics/building-overlays-in-composer/composer-reference.md): Get to know Composer, where you create and edit custom overlays - [Controlling overlays in Studio and UNO](https://developer.singular.live/singular-basics/controlling-overlays-in-studio-and-uno.md): Learn how to use Singular's control applications. - [How to use Studio](https://developer.singular.live/singular-basics/controlling-overlays-in-studio-and-uno/how-to-use-studio.md) - [Studio reference](https://developer.singular.live/singular-basics/controlling-overlays-in-studio-and-uno/studio-reference.md) - [UNO reference](https://developer.singular.live/singular-basics/controlling-overlays-in-studio-and-uno/uno-reference.md): UNO Overview - [Singular status](https://developer.singular.live/support/singular-status.md) - [Support resources](https://developer.singular.live/support/support-resources.md) - [Singular terminology](https://developer.singular.live/support/singular-terminology.md): A glossary of common Singular concepts - [Performance Testing and Browser Diagnostics](https://developer.singular.live/support/performance-testing-and-browser-diagnostics.md): Overlay examples to test the performance of your hardware, encoding pipeline, and check its compatibility. --- # 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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://developer.singular.live/portal-overview.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.