> For the complete documentation index, see [llms.txt](https://developers.didomi.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.didomi.io/api-and-platform.md).

# API & Platform

- [Introduction](https://developers.didomi.io/api-and-platform/introduction.md)
- [Authentication](https://developers.didomi.io/api-and-platform/introduction/authentication.md)
- [Errors](https://developers.didomi.io/api-and-platform/introduction/errors.md)
- [Pagination](https://developers.didomi.io/api-and-platform/introduction/pagination.md)
- [Filters](https://developers.didomi.io/api-and-platform/introduction/filters.md)
- [Caching](https://developers.didomi.io/api-and-platform/introduction/caching.md)
- [Rate limiting](https://developers.didomi.io/api-and-platform/introduction/rate-limiting.md)
- [Quotas](https://developers.didomi.io/api-and-platform/introduction/quotas.md)
- [Translations](https://developers.didomi.io/api-and-platform/introduction/translations.md)
- [Data Manager](https://developers.didomi.io/api-and-platform/data-manager.md)
- [Regulations](https://developers.didomi.io/api-and-platform/data-manager/regulations.md)
- [Configuration Tree](https://developers.didomi.io/api-and-platform/data-manager/configuration-tree.md)
- [Purposes](https://developers.didomi.io/api-and-platform/data-manager/purposes.md)
- [Purposes & Vendors Numerical IDs](https://developers.didomi.io/api-and-platform/data-manager/purposes/purposes-and-vendors-numerical-ids.md)
- [Preferences Library](https://developers.didomi.io/api-and-platform/data-manager/preferences-library.md)
- [User Rights](https://developers.didomi.io/api-and-platform/data-manager/user-rights.md)
- [Widgets](https://developers.didomi.io/api-and-platform/widgets.md)
- [Consent notices](https://developers.didomi.io/api-and-platform/widgets/consent-notices.md): How to manage consent notices via the Didomi API
- [Notices](https://developers.didomi.io/api-and-platform/widgets/consent-notices/notices.md)
- [Configurations](https://developers.didomi.io/api-and-platform/widgets/consent-notices/configurations.md)
- [Multi-Regulation Configurations](https://developers.didomi.io/api-and-platform/widgets/consent-notices/multi-reg-configurations.md): This page explains how consent notices support multiple regulations that are displayed in different countries and regions, and how to work with those notice configurations.
- [Migration of Existing Notices and API Updates](https://developers.didomi.io/api-and-platform/widgets/consent-notices/multi-reg-configurations/migration-of-existing-notices-and-api-updates.md): This page describes how Didomi migrated pre-existing Configurations to support multiple regulations, and important changes to the Notice and Configuration API endpoints.
- [Deployments](https://developers.didomi.io/api-and-platform/widgets/consent-notices/deployments.md)
- [Tutorials](https://developers.didomi.io/api-and-platform/widgets/consent-notices/tutorials.md)
- [Create and publish a consent notice](https://developers.didomi.io/api-and-platform/widgets/consent-notices/tutorials/tutorial.md)
- [Create and publish a multi-regulation consent notice](https://developers.didomi.io/api-and-platform/widgets/consent-notices/tutorials/tutorial-1.md)
- [Privacy widgets](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets.md)
- [Create a widget](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/create-a-widget.md)
- [Retrieve widgets](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/retrieve-widgets.md)
- [Edit a widget](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget.md)
- [Content & Design](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design.md)
- [Themes & Shapes](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/themes-and-shapes.md)
- [Components](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components.md)
- [auth](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/auth.md)
- [dsar\_form](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/dsar_form.md)
- [footer](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/footer.md)
- [header](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/header.md)
- [preference](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/preference.md)
- [preference\_value](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/preference_value.md)
- [save](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/save.md)
- [section](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/section.md)
- [sections](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/components/sections.md)
- [Options](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/options.md)
- [Breakpoints](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/content-and-design/breakpoints.md): Breakpoints allow you to define responsive widget styles that adapt to different screen sizes, ensuring optimal rendering on mobile, tablet, and desktop.
- [Purposes & preferences](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/purposes-and-preferences.md)
- [Settings](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/edit-a-widget/settings.md)
- [Deploy a Widget](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/deploy-a-widget.md)
- [Use a Didomi managed domain](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/deploy-a-widget/use-your-own-subdomain.md)
- [Use your own domain](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/deploy-a-widget/use-your-own-domain.md)
- [Implement an embeddable widget on your website](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/deploy-a-widget/implement-an-embeddable-widget-on-your-website.md)
- [Authentication](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/authentication.md)
- [Manage authentication providers](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/authentication/manage-authentication-providers.md)
- [Authenticate your end-user](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/authentication/authenticate-your-end-user.md)
- [Archive a widget](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/archive-a-widget.md)
- [Headless widgets](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/headless-widgets.md)
- [Public Methods](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/headless-widgets/public-methods.md)
- [Custom elements](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/headless-widgets/custom-elements.md)
- [Custom events](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/headless-widgets/custom-events.md)
- [Event listeners](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/headless-widgets/event-listeners.md)
- [Processing Rules](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/launch-from-a-mobile-app.md)
- [Tutorial](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/tutorial.md)
- [Launch a Preference Center from a mobile app](https://developers.didomi.io/api-and-platform/widgets/privacy-widgets/tutorial/launch-from-a-mobile-app.md): How to launch a Preference Center from a mobile app
- [Compliance Reports](https://developers.didomi.io/api-and-platform/monitoring-and-reporting.md)
- [Properties](https://developers.didomi.io/api-and-platform/monitoring-and-reporting/properties.md)
- [Reports](https://developers.didomi.io/api-and-platform/monitoring-and-reporting/reports.md)
- [CSV format reference](https://developers.didomi.io/api-and-platform/monitoring-and-reporting/excel-format-reference.md)
- [Websites](https://developers.didomi.io/api-and-platform/monitoring-and-reporting/properties-1.md)
- [Consents and Preferences](https://developers.didomi.io/api-and-platform/consents.md)
- [Events](https://developers.didomi.io/api-and-platform/consents/events.md)
- [Consent event schema](https://developers.didomi.io/api-and-platform/consents/events/consent-event-schema.md)
- [Create consent event](https://developers.didomi.io/api-and-platform/consents/events/create-consent-event.md)
- [Consent event approvals](https://developers.didomi.io/api-and-platform/consents/events/consent-event-approvals.md)
- [Consent event delegates](https://developers.didomi.io/api-and-platform/consents/events/consent-event-delegates.md)
- [Query consent events](https://developers.didomi.io/api-and-platform/consents/events/query-consent-events.md)
- [Delete consent event](https://developers.didomi.io/api-and-platform/consents/events/delete-consent-event.md)
- [Disable integrations in consent event](https://developers.didomi.io/api-and-platform/consents/events/disable-integrations-in-consent-event.md)
- [Generate IAB TCF consent string](https://developers.didomi.io/api-and-platform/consents/events/generate-iab-tcf-consent-string.md)
- [Links](https://developers.didomi.io/api-and-platform/consents/links.md)
- [Proofs](https://developers.didomi.io/api-and-platform/consents/proofs.md)
- [Tokens](https://developers.didomi.io/api-and-platform/consents/tokens.md)
- [Secrets](https://developers.didomi.io/api-and-platform/consents/secrets.md)
- [Users](https://developers.didomi.io/api-and-platform/consents/users.md)
- [Users schema](https://developers.didomi.io/api-and-platform/consents/users/users-schema.md)
- [Create user](https://developers.didomi.io/api-and-platform/consents/users/create-user.md)
- [One-click consent and user consent status](https://developers.didomi.io/api-and-platform/consents/users/one-click-consent-and-user-consent-status.md)
- [Query user](https://developers.didomi.io/api-and-platform/consents/users/query-user.md)
- [Disable integrations for users](https://developers.didomi.io/api-and-platform/consents/users/disable-integrations-for-users.md)
- [Tutorial](https://developers.didomi.io/api-and-platform/consents/tutorial.md)
- [Collect and operate data](https://developers.didomi.io/api-and-platform/consents/tutorial/collect-and-operate-data.md)
- [Privacy Requests](https://developers.didomi.io/api-and-platform/privacy-requests.md)
- [Requests](https://developers.didomi.io/api-and-platform/privacy-requests/requests.md)
- [Notes](https://developers.didomi.io/api-and-platform/privacy-requests/notes.md)
- [Links](https://developers.didomi.io/api-and-platform/privacy-requests/links.md)
- [Emails](https://developers.didomi.io/api-and-platform/privacy-requests/emails.md)
- [Domains](https://developers.didomi.io/api-and-platform/domains.md)
- [Serve Didomi assets from your domain (web)](https://developers.didomi.io/api-and-platform/domains/serve-didomi-assets-from-your-domain.md)
- [Serve Didomi assets from your domain (mobile)](https://developers.didomi.io/api-and-platform/domains/serve-didomi-assets-from-your-domain-mobile.md)
- [Domain delegation](https://developers.didomi.io/api-and-platform/domains/domain-delegation.md)
- [Reverse proxy](https://developers.didomi.io/api-and-platform/domains/reverse-proxy.md)
- [Implementation guides](https://developers.didomi.io/api-and-platform/domains/reverse-proxy/implementation-guides.md)
- [Cloudflare](https://developers.didomi.io/api-and-platform/domains/reverse-proxy/implementation-guides/cloudflare.md)
- [AWS Cloudfront](https://developers.didomi.io/api-and-platform/domains/reverse-proxy/implementation-guides/aws-cloudfront.md)
- [Fastly](https://developers.didomi.io/api-and-platform/domains/reverse-proxy/implementation-guides/fastly.md)
- [Reference](https://developers.didomi.io/api-and-platform/reference.md)
- [Releases](https://developers.didomi.io/api-and-platform/reference/releases.md)
- [API specifications](https://developers.didomi.io/api-and-platform/reference/api-specifications.md)


---

# 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://developers.didomi.io/api-and-platform.md?ask=<question>&goal=<user_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.