> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/umbraco-ui-builder/advanced/async-apis.md).

# Async APIs

Learn about Async API Changes

UI Builder `17.1.0` adds EF Core support, converting the data access pipeline to async-first. This update impacts API controllers, services, repositories, and database extensions. Existing sync methods are now obsolete and scheduled for removal in V19.

This migration handled the following:

* Every existing sync method gets an async counterpart with an `Async` suffix.
* Sync methods are marked `[Obsolete("Scheduled for removal in v19")]`.
* Sync methods are rewired to delegate to async via `.ConfigureAwait(false).GetAwaiter().GetResult()`.
* All async methods accept an optional `CancellationToken cancellationToken = default` as the last parameter.

## Deprecation Timeline

| Version        | Status                                                 |
| -------------- | ------------------------------------------------------ |
| **Version 17** | Sync methods marked `[Obsolete]`, async methods added. |
| **Version 19** | Sync methods removed.                                  |

## Migration Guide for Custom Repository Implementations

If you have a custom repository extending `Repository<TEntity, TId>` (or use the new `EFCoreRepository<TEntity, TId>`):

1. Implement all new `*ImplAsync` abstract methods.
2. Migrate callers from sync to async methods.
3. Pass `CancellationToken` through the call chain.
4. The sync `*Impl` methods still work but will be removed in version 19.

```csharp
// Before (v16)
protected override TEntity GetImpl(TId id)
{
    return _myDataSource.Get(id);
}

// After (v17+)
protected override async Task<TEntity> GetImplAsync(TId id, CancellationToken cancellationToken)
{
    return await _myDataSource.GetAsync(id, cancellationToken);
}
```


---

# 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.umbraco.com/umbraco-ui-builder/advanced/async-apis.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.