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

# Regenerate access token

> Regenerates a new access token for the system.



## OpenAPI

````yaml /openapi/adm.openapi.en-0.2.2.json post /settings/access_token
openapi: 3.1.0
info:
  description: >
    ## Introduction

    The Data Management APIs comprehensively oversees the **diverse data** used
    by advertising and recommendation systems, ensuring that the Decision API
    runs accurately and efficiently.


    From registering, updating, and deleting campaigns and placements to **log
    and statistics analysis**, it provides the insights necessary for effective
    system operation.


    The resulting data and metrics are used by the Decision API to **optimize ad
    and content decisions**, ultimately boosting the overall performance of the
    advertising and recommendation system.
  title: Data Management APIs
  version: 0.1.3
servers: []
security: []
tags:
  - name: Audience Targeting
  - description: >

      The Audience Management APIs to seamlessly integrate Audience-related
      data.  


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Audience
  - description: >
      APIs for collecting user activity data to enhance ad targeting and
      performance optimization.


      Activity Data captures actual user behavior data like product views,
      searches, cart additions, and purchases across all users, regardless of ad
      interactions.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Activity Log
  - description: >

      The Audience Attribute API provides access to audience attribute data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Attribute
  - description: >

      The Audience Segment API provides access to audience segment data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Segment
  - description: The Analytic API provides access to dashboard and A2 metric data.
    name: Analytic
  - description: >

      The Billing API manages billing information.

      A2 is configured to work with the payment systems used by your retail
      platform.


      To integrate payments, first you need to register an external channel.

      For more information about integrating A2 with external channels, check
      out [the External channels
      page](https://docs.aiderx.io/guides/about-a2/en/external-channel).
    name: Billing
  - description: |

      The Campaign API allows you to manage data related to campaigns.

      References:
      - [Campaign](https://docs.aiderx.io/guides/about-a2/en/campaign)
    name: Campaign
  - description: >

      The Creative API provides comprehensive functionalities for managing
      creative assets and related resources.


      References:

      - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative)
    name: Creative
  - description: >

      The Allocation API provides comprehensive functionalities for managing
      allocation and related resources.


      References:

      - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation)
    name: Allocation
  - description: >

      The Media Library API provides comprehensive functionalities for managing
      media library and related resources.


      References:

      - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library)
    name: Media Library
  - description: >

      The Catalog Management API provides functionalities for managing catalogs
      and related resources.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Catalog
  - description: >

      The Placement Management API provides comprehensive functionalities for
      managing placements and related resources.


      References:

      - [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: Placement
  - description: >

      Placement Catalog transforms the placement information into a structured
      “advertising product” that can be easily showcased to advertisers.


      References:

      - To be updated
    name: Placement Catalog
  - description: >

      The System APIs allow you to access and manage system-level settings and
      assets, such as logos and configuration values.


      References:

      - [Yield Optimization
      Settings](https://docs.aiderx.io/guides/about-a2/en/yield-optimization)
    name: System
  - description: >

      The Auth and User API provides authentication and user management
      functionalities.


      References:

      - [Account and
      Budget](https://docs.aiderx.io/guides/about-a2/en/account-and-budget)
    name: Auth and User
  - description: |

      The License API provides license management functionalities.
    name: License
paths:
  /settings/access_token:
    post:
      tags:
        - System
      summary: Regenerate access token
      description: Regenerates a new access token for the system.
      operationId: handle_access_token_setting_settings_access_token_post
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingSchema'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Internal Server Error
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    SettingSchema:
      description: Schema for Setting
      properties:
        access_token:
          anyOf:
            - $ref: '#/components/schemas/BearerToken'
            - type: 'null'
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The date and time the entity was created.
          title: Created At
        currency:
          description: Currency code for the system. It is used for the budget management.
          examples:
            - usd
            - krw
          title: Currency
          type: string
        external_channel_url:
          anyOf:
            - type: string
            - type: 'null'
          description: External channel URL which will be used on budget management.
          title: External Channel Url
        language:
          description: Language code for the system.
          examples:
            - en
            - ko
          title: Language
          type: string
        tls_domain:
          anyOf:
            - type: string
            - type: 'null'
          description: TLS domain name.
          title: Tls Domain
        tls_enable:
          description: Whether TLS is enabled.
          title: Tls Enable
          type: boolean
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The date and time the entity was last updated.
          title: Updated At
        yield_optimization:
          anyOf:
            - $ref: '#/components/schemas/YieldOptimization'
            - type: 'null'
      required:
        - tls_enable
        - tls_domain
        - currency
        - language
        - access_token
        - external_channel_url
        - yield_optimization
      title: SettingSchema
      type: object
    HTTPExceptionResponse:
      description: HTTPException response model.
      properties:
        detail:
          description: Detailed explanation for the exception
          title: Detail
          type: string
      required:
        - detail
      title: HTTPExceptionResponse
      type: object
    BearerToken:
      description: Access token info
      properties:
        access_token:
          description: Access token.
          title: Access Token
          type: string
        token_type:
          default: Bearer
          title: Token Type
          type: string
      required:
        - access_token
      title: BearerToken
      type: object
    YieldOptimization:
      description: Yield optimization settings
      properties:
        ceiling_cpm:
          description: The maximum CPM value for bidding amount.
          title: Ceiling Cpm
          type: number
        floor_cpm:
          description: The minimum CPM value for bidding amount.
          title: Floor Cpm
          type: number
        yield_roas_balance:
          description: >

            Set the balance between ROAS and eCPM.

            Moving the value closer to 0 will favor the advertiser’s ROAS, while
            moving it closer to 1 will favor higher eCPM.
          maximum: 1
          minimum: 0
          title: Yield Roas Balance
          type: number
      required:
        - floor_cpm
        - ceiling_cpm
        - yield_roas_balance
      title: YieldOptimization
      type: object
  securitySchemes:
    OAuth2PasswordBearer:
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login
      type: oauth2

````