> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Обновление банковского подключения через API: синхронизация

> Эндпоинт Didit для обновления банковского подключения: 202 с sync_id или 200 с готовой синхронизацией, если ждать до 25 секунд.

Endpoint Didit Refresh a Bank Connection запрашивает синхронизацию прямо сейчас и возвращает `202` с `sync_id`.
Отправьте `"wait": true`, чтобы ждать до 25 секунд и получить результат завершённой синхронизации одним вызовом, без дополнительной оплаты.
Банк ограничивает доступ без участия пользователя, поэтому вызов может вернуть `429 refresh_limit_reached` с заголовком `Retry-After`.
См. [Обновление банковских данных по запросу](https://docs.didit.me/ru/use-cases/refresh-bank-data-on-demand.md).


## OpenAPI

````yaml ru/openapi-25.json POST /v3/bank/connections/{id}/refresh/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API верификации личности. Аутентификация через заголовок x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, подключения, счета, балансы, транзакции, учреждения и покрытие.
      Банковские данные доступны для приложений в песочнице. Вызовы из
      приложения в продакшн-среде возвращают `404`, пока доступ к такой среде не
      объявлен. В песочнице ничего не списывается. Вызов, выполненный с
      API-ключом, требует ключа с разрешением на банковские данные
      (`bank-data`): read для чтения, write для операций, которые что-то меняют.
      Проверка счёта является исключением: для неё нужен доступ write к сессиям
      или полный доступ, а не разрешение на банковские данные. Банковские данные
      не входят в полный доступ: ключ с полным доступом отклоняется, и вызов
      возвращает `403 bank_data_access_denied`, пока вы не создадите ключ с этим
      разрешением. Необработанные банковские данные (счета, балансы, транзакции
      и лента изменений) также отклоняют запрос без API-ключа.


      Каждый отказ под `/v3/bank/`, кроме отказа проверки счёта, имеет одно и то
      же тело JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Путь, который не является операцией, идентификатор,
      который не является UUID, или неизвестный подресурс возвращают `404
      not_found` для любого метода, а любая непредвиденная ошибка возвращает
      `500 internal_error` с `request_id`. Там, где банковские данные
      недоступны, каждая операция возвращает стандартный `404` платформы, точно
      так же, как неизвестный маршрут.
paths:
  /v3/bank/connections/{id}/refresh/:
    post:
      tags:
        - Bank Data
      summary: Обновить банковское подключение
      description: >-
        Синхронизирует сейчас: запрашивает у банка новые данные в любой момент.
        Возвращает `202` с `sync_id`; если синхронизация уже выполняется, вы
        получите тот же `sync_id`, а не второе задание. Если в теле запроса
        передано `"wait": true` или в заголовке `Prefer: wait=<seconds>` (до
        25), вызов ждёт до 25 секунд и возвращает `200` с завершённой
        синхронизацией (`outcome`, количество по каждому счёту и
        `balances_changed`), так что один запрос отдаёт свежие данные. Если банк
        не ответил за это время, вызов возвращает `202`: прочитайте
        синхронизацию через `get_sync_run` по `sync_id` или подпишитесь на
        `bank.sync.completed`. `bank.data.updated` приходит только тогда, когда
        синхронизация сохраняет изменения.


        Живые синхронизации входят в месячную цену подключения, как и
        автоматические: ничего дополнительно не списывается. Единственное
        ограничение задаёт банк. Банки ограничивают чтение без участия клиента,
        например четырьмя запросами в день (тестовый банк Didit в песочнице
        работает так же). Сначала отводятся автоматические синхронизации дня
        (`sync.frequency_per_day`), остальные остаются вам, поэтому
        `sync.budgets` показывает остаток, а `sync.live_syncs_left_today`
        показывает, сколько живых синхронизаций осталось сегодня. Автоматическое
        расписание никогда не использует последние два чтения дня, поэтому две
        живые синхронизации всегда остаются. Когда бюджет исчерпан, вызов
        возвращает `429 refresh_limit_reached` с `Retry-After` (секунды до
        сброса бюджета, от 1 до 86400) и объектом `sync` с
        `live_syncs_left_today` и `budgets`. Это предел, установленный банком, а
        не гарантия определённого количества синхронизаций.


        Когда синхронизация сохраняет изменения, `bank.data.updated` сообщает об
        этом; затем прочитайте ленту изменений.


        Нужен API-ключ с разрешением на доступ к банковским данным
        (`bank-data`): для этой операции требуется разрешение на запись, так как
        она что-то меняет. Ключ с полным доступом это разрешение не включает:
        выдайте его явно при создании ключа, иначе вызов вернёт `403
        bank_data_access_denied`.


        Обновление удалённого подключения возвращает `409
        connection_not_active`.
      operationId: refreshBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор подключения.
        - $ref: '#/components/parameters/IdempotencyKey'
        - name: Prefer
          in: header
          required: false
          schema:
            type: string
            example: wait=25
          description: >-
            `wait=<seconds>` удерживает вызов до указанного количества секунд,
            но не более 25, как `wait: true` в теле запроса.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankRefreshRequest'
            examples:
              Wait for the result:
                summary: Дождитесь результата
                value:
                  wait: true
      responses:
        '200':
          description: Синхронизация завершилась в течение 25 секунд.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncCompleted'
              examples:
                Finished:
                  summary: Завершённая синхронизация в продакшн-среде
                  value:
                    id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    connection_id: 5e1d2a70-6b3c-4f8e-a1d9-0c7b2e4f8a36
                    trigger: requested
                    status: succeeded
                    started_at: '2026-11-21T12:30:02Z'
                    finished_at: '2026-11-21T12:30:09Z'
                    results:
                      - account_id: a71f0c2e-4d85-4b1a-9e63-2f8c0d5b7a14
                        resource: transactions
                        outcome: succeeded
                        added: 3
                        modified: 0
                        removed: 1
                        error: null
                    outcome: succeeded
                    balances_changed: true
                    error: null
        '202':
          description: >-
            Обновление принято: в очереди или уже выполняется. При `wait` банк
            не ответил за 25 секунд: проверьте синхронизацию по `sync_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankRefreshAccepted'
              examples:
                Queued:
                  summary: Синхронизация поставлена в очередь
                  value:
                    sync_id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    status: queued
                    next_refresh_at: null
        '400':
          description: >-
            Тело запроса некорректно, например `wait` не является логическим
            значением. В `field` указано поле с ошибкой.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid request:
                  summary: Недопустимый запрос
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: wait
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: Ресурс не существует в этом приложении и среде.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Не найдено
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '409':
          description: >-
            Подключение нельзя обновить: `connection_not_active` (отозвано,
            приостановлено, завершилось ошибкой или удалено) или
            `consent_expired` (сначала продлите его).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Не активно
                  value:
                    code: connection_not_active
                    message: This connection is not active.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: create_link
                    retry_after: null
                Consent expired:
                  summary: Согласие истекло
                  value:
                    code: consent_expired
                    message: The consent ended. Renew the connection to sync again.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: renew_connection
                    retry_after: null
        '429':
          description: Лимит банка на запросы данных без участия пользователя исчерпан.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankRefreshLimitError'
              examples:
                Refresh limit reached:
                  summary: Достигнут лимит обновлений
                  value:
                    code: refresh_limit_reached
                    message: >-
                      The bank's limit on fetches without the person present is
                      used up for today.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: retry_later
                    retry_after: 3600
                    sync:
                      live_syncs_left_today: 0
                      budgets:
                        - scope: connection
                          resource: all
                          limit: 4
                          remaining: 0
                          resets_at: '2026-11-22T00:00:00Z'
          headers:
            Retry-After:
              description: Количество секунд ожидания перед повторным запросом.
              schema:
                type: integer
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/refresh/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.refresh_connection(
                "11111111-2222-3333-4444-555555555555",
                wait=True,
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.refreshConnection("11111111-2222-3333-4444-555555555555",
            {
              wait: true,
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.RefreshConnection(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankRefreshConnectionParams{\n\tBody: didit.BankRefreshRequest{\n\t\tWait: didit.Bool(true),\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.BankRefreshConnectionParams;

            import me.didit.types.BankRefreshRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().refreshConnection("11111111-2222-3333-4444-555555555555",
            BankRefreshConnectionParams.builder()
                    .wait_(true)
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->bank->refreshConnection('11111111-2222-3333-4444-555555555555',
            [
                'wait' => true,
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.refresh_connection(
              "11111111-2222-3333-4444-555555555555",
              wait: true
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.RefreshConnectionAsync("11111111-2222-3333-4444-555555555555",
            new BankRefreshRequest

            {
                Wait = true,
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Необязательный ключ для безопасных повторных запросов, который вы
        выбираете для одной операции, до 255 символов (подойдёт UUID). Запрос,
        повторённый с тем же ключом, endpoint, параметрами запроса и телом,
        получает первый ответ с тем же статусом и тем же телом и не выполняется
        и не тарифицируется повторно. Тот же ключ с другим endpoint, параметрами
        запроса или телом возвращает `409` `idempotency_key_reused`, а пока
        первый запрос ещё выполняется, `409` `idempotency_key_in_progress` с
        `Retry-After`. Неудачный запрос (любой `4xx` или `5xx`) не сохраняется,
        поэтому его можно отправить повторно с тем же ключом. Ключи принадлежат
        вашему приложению, независимо от того, вызываете ли вы API с API-ключом
        или с токеном доступа. См. [Повторные попытки и
        идемпотентность](/ru/integration/api-errors#повторные-попытки-и-идемпотентность).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankRefreshRequest:
      type: object
      description: Необязательное тело запроса на обновление.
      properties:
        wait:
          type: boolean
          default: false
          description: >-
            `true` удерживает вызов до 25 секунд и возвращает `200` с
            завершенной синхронизацией, так что один запрос отдает актуальные
            данные. Если банк не ответил за это время, вызов возвращает `202`:
            получите синхронизацию через `get_sync_run`, используя `sync_id`,
            или подпишитесь на `bank.sync.completed`. `bank.data.updated`
            приходит, только если синхронизация сохранила изменения. Заголовок
            `Prefer: wait=<seconds>` (до 25) работает так же.
    BankSyncCompleted:
      allOf:
        - $ref: '#/components/schemas/BankSyncRun'
        - type: object
          properties:
            outcome:
              type: string
              enum:
                - succeeded
                - partial
                - failed
              description: Как завершилась синхронизация.
            balances_changed:
              type: boolean
              description: Изменился ли какой-либо баланс.
          required:
            - outcome
            - balances_changed
      description: >-
        Завершённая синхронизация, возвращённая обновлением с `wait`: запуск
        синхронизации с его `outcome`, количество по каждому счёту в `results` и
        `balances_changed`.
    BankRefreshAccepted:
      type: object
      description: >-
        Обновление принято. Повторный вызов во время выполнения синхронизации
        возвращает тот же `sync_id`.
      properties:
        sync_id:
          type: string
          description: >-
            Синхронизация, которая была поставлена в очередь, или уже
            выполняющаяся.
          format: uuid
        status:
          type: string
          enum:
            - queued
            - running
        next_refresh_at:
          type: string
          description: >-
            Самый ранний момент, когда можно запросить новое обновление. `null`,
            если только не исчерпан бюджет.
          format: date-time
          nullable: true
      required:
        - sync_id
        - status
        - next_refresh_at
    BankDataError:
      type: object
      description: >-
        Тело ошибки для каждой операции с банковскими данными. Все поля всегда
        присутствуют.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Машиночитаемый код ошибки. Ориентируйтесь на него в логике
            обработки, но никогда не на `message`.
        message:
          type: string
          description: >-
            Пояснение простым языком для разработчика. Формулировка может
            измениться; не разбирайте её программно.
        request_id:
          type: string
          description: Идентификатор этого запроса. Укажите его при обращении в поддержку.
        field:
          type: string
          description: >-
            Поле запроса, которое нужно исправить, если ошибка относится к
            одному полю. В остальных случаях `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            Какие действия выполнить дальше, чтобы клиент мог действовать без
            догадок. `null`, если стандартного следующего шага нет.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Количество секунд ожидания перед повторной попыткой. Задаётся при
            ошибках превышения лимита и при временных ошибках, иначе `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankRefreshLimitError:
      allOf:
        - $ref: '#/components/schemas/BankDataError'
        - type: object
          properties:
            sync:
              type: object
              description: Текущие ограничения синхронизации подключения.
              properties:
                live_syncs_left_today:
                  type: integer
                  nullable: true
                  minimum: 0
                budgets:
                  type: array
                  items:
                    $ref: '#/components/schemas/BankSyncBudget'
              required:
                - live_syncs_left_today
                - budgets
          required:
            - sync
      description: >-
        Ошибка лимита обновления с лимитами `sync` подключения. `Retry-After`
        содержит количество секунд до сброса бюджета, от 1 до 86400.
    BankSyncRun:
      type: object
      description: >-
        Одна синхронизация подключения. Перечислены только первоначальные,
        плановые и запрошенные синхронизации.
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
        trigger:
          type: string
          enum:
            - initial
            - scheduled
            - requested
        status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - partial
            - failed
        started_at:
          type: string
          format: date-time
          nullable: true
        finished_at:
          type: string
          format: date-time
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncRunResult'
          description: Что выполнил запуск, по каждому счёту и ресурсу.
        error:
          type: object
          nullable: true
          description: >-
            Почему запуск завершился ошибкой в целом. `null`, если запуск не
            завершился ошибкой. Ошибки отдельных счетов и ресурсов находятся в
            `results`.
          properties:
            code:
              type: string
            message:
              type: string
            at:
              type: string
              format: date-time
          required:
            - code
            - message
            - at
      required:
        - id
        - connection_id
        - trigger
        - status
        - started_at
        - finished_at
        - results
        - error
    BankSyncBudget:
      type: object
      description: >-
        Один сегмент лимита банка на получение данных без присутствия
        пользователя.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Относительно чего банк учитывает бюджет.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: Счёт, если `scope` равен `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Сколько раз в день Didit может запрашивать данные у банка без
            участия пользователя, как это определяет банк. Это потолок,
            установленный банком, а не гарантия.
        remaining:
          type: integer
          description: >-
            Оставшиеся запросы на обновление данных в текущем окне. Чтения,
            зарезервированные для автоматической синхронизации, уже вычтены, и
            автоматическая синхронизация никогда не забирает последние два
            чтения за день, поэтому два обновления по запросу всегда остаются
            доступны.
        resets_at:
          type: string
          description: Когда окно сбрасывается.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncRunResult:
      type: object
      properties:
        account_id:
          type: string
          description: '`null` для результата по всему подключению.'
          format: uuid
          nullable: true
        resource:
          type: string
          enum:
            - accounts
            - balances
            - transactions
        outcome:
          type: string
          enum:
            - succeeded
            - failed
            - skipped
        added:
          type: integer
        modified:
          type: integer
        removed:
          type: integer
        error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: Обязательно, когда `outcome` равен `failed`.
      required:
        - account_id
        - resource
        - outcome
        - added
        - modified
        - removed
        - error
    BankSyncError:
      type: object
      description: Почему не удалась синхронизация.
      properties:
        code:
          type: string
          description: Код ошибки Didit.
        message:
          type: string
          description: Пояснение простым языком.
        at:
          type: string
          description: Когда это произошло. `null` для результата по отдельному счёту.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: Не авторизован
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Недействительный API-ключ
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        API-ключ не имеет разрешения на доступ к банковским данным (`bank-data`)
        или, для необработанных банковских данных в продакшн-приложении,
        отключена настройка приложения «Bank data in the API». Банковские данные
        не входят в полный доступ: ключ с полным доступом, ключ с ограничением
        на другие ресурсы и запрос без API-ключа (client credentials, для
        необработанных данных) отклоняются с этим ответом, поэтому создайте ключ
        и выдайте разрешение явно. Отказ происходит до любого поиска, поэтому он
        ничего не говорит о том, существует ли объект.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Доступ к банковским данным не разрешён
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    BankDataInternalError:
      description: >-
        Что-то пошло не так на стороне Didit. Любая непредвиденная ошибка в
        `/v3/bank/` возвращается в формате ошибки Bank, а не в виде
        HTML-страницы: укажите `request_id` в обращении в поддержку.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Непредвиденная ошибка
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения берётся в разделе Developers -> API keys в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        можно ограничить: доступ для каждого ресурса (нет доступа, только чтение
        или запись), ограничение некоторыми сценариями или одобренными сессиями,
        список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ
        неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у
        ключа нет доступа к этому ресурсу или действию либо запрос пришёл с
        адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что
        сессия находится вне сценариев или статусов, доступных ключу. Ключ без
        доступа к медиа получает URL изображений, видео и PDF как null, а ключ
        без права записи в сессии получает ссылки и токены сессий как null. См.
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.