Aghanim Translation Glossaries API

openapi: 3.1.0
info:
  title: Aghanim Server-to-Server Achievements Translation Glossaries API
  description: "The Aghanim Server-to-Server API is designed for **backend server integrations only**. Use this API when you need to automate game hub updates from your server-side applications.\n\n\n## OpenAPI Specification\n\nYou can download the [OpenAPI](https://www.openapis.org/) specification for this API at the following link:\n[docs.aghanim.com/openapi.json](https://docs.aghanim.com/openapi.json).\n\n## Changelog\n\nSee the [S2S API Changelog](https://docs.aghanim.com/s2s-api/changelog/) for a history of changes to this API.\n\n## Authentication\n\nAghanim supports two methods of authentication: **Bearer token** and **Basic authentication**.\n\nTo authenticate, you will need your API key, which can be retrieved from\nthe Aghanim Dashboard → [**Game → Integration → API Keys**](https://dashboard.aghanim.com/go/integration/api-keys).\n\n**⚠️ Security Notice**: The S2S API key is **secret** and must be kept secure on your server. Never expose the S2S API key in client-side code, mobile apps, or any public-facing applications.\n\n### Bearer Token Authentication\n\nUse the Bearer method by including an `Authorization` header with the word `Bearer`\nfollowed by your API key. The `Authorization` header in your HTTP request should look like this: `Authorization: Bearer API_KEY`\n\n### Basic Authentication\n\nAlternatively, you can authenticate using Basic authentication. Your API key is used\nas the `username`, and the `password` should be left empty. Send an `Authorization`\nheader with the word `Basic` followed by a base64-encoded string\nin the format `API_KEY:` (note the colon at the end).\n\nThe `Authorization` header should look like this: `Authorization: Basic ZGVtbzpwQDU1dzByZA==`\n\n## Error Codes\n\nAghanim employs standard HTTP response codes to denote the success or failure of an API request.\nBelow is a table detailing error codes.\n\n| Code | Description |\n| ---- | ----------- |\n| 200  | OK          |\n| 400  | Bad request |\n| 401  | Not authenticated |\n| 403  | Not authorized |\n| 404  | Resource not found |\n| 409  | Conflict. Request conflicts with current state of resource |\n| 422  | Validation error |\n| 429  | Too many requests. Rate limit exceeded |\n| 503  | Server unavailable |\n\n### Generic error schema\n\n```json\n{\n  \"detail\": \"string\"\n}\n```\n\n### Validation error schema\n\n```json\n{\n  \"detail\": [\n    {\n      \"loc\": [\n        \"string\",\n        0\n      ],\n      \"msg\": \"string\",\n      \"type\": \"string\"\n    }\n  ]\n}\n```\n\n## Rate Limits\n\nThe Aghanim API has rate limiting in place to avoid overloading and to ensure it remains stable.\nThe allowable rate of requests is capped at 1,000 per minute for every game.\nGame developers who exceed this limit will receive a 429 error code.\n\nTo increase the rate limit, please contact us via [integration@aghanim.com](mailto:integration@aghanim.com).\n\n## Pagination\n\nIn the Aghanim API, pagination is managed through the use of the `limit` and `offset` query parameters.\nThese parameters allow to fine-tune your data retrieval requests by specifying:\n\n- `limit`: the number of records to be returned in a single request.\n- `offset`: indicates the number of records to skip from the start of the dataset.\n"
  contact:
    name: Aghanim
    email: integration@aghanim.com
  version: 2026.07.14
servers:
- url: https://api.aghanim.com/s2s
  description: Production
tags:
- name: Translation Glossaries
paths:
  /v1/translation_glossaries:
    get:
      tags:
      - Translation Glossaries
      summary: Get Translation Glossaries
      description: Returns a list of translation glossaries.
      operationId: get_translation_glossaries
      security:
      - HTTPBearer: []
      parameters:
      - name: locale_id
        in: query
        required: false
        schema:
          title: Locale Id
          description: Filter by locale
          type: string
        description: Filter by locale
      - name: q
        in: query
        required: false
        schema:
          title: Q
          description: Filter by search query
          type: string
        description: Filter by search query
      - name: limit
        in: query
        required: false
        schema:
          title: Limit
          description: A limit on the number of objects to be returned
          default: 10
          type: integer
        description: A limit on the number of objects to be returned
      - name: starting_after
        in: query
        required: false
        schema:
          title: Starting After
          description: The cursor for pagination
          type: string
        description: The cursor for pagination
      - name: ending_before
        in: query
        required: false
        schema:
          title: Ending Before
          description: The cursor for pagination
          type: string
        description: The cursor for pagination
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfinitePaginatedResponse_TranslationGlossaryRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Translation Glossaries
      summary: Create Translation Glossary
      description: Creates a new translation glossary.
      operationId: create_translation_glossary
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranslationGlossaryCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranslationGlossaryRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/translation_glossaries/{translation_glossary_id}:
    get:
      tags:
      - Translation Glossaries
      summary: Get Translation Glossary
      description: Returns a single translation glossary.
      operationId: get_translation_glossary
      security:
      - HTTPBearer: []
      parameters:
      - name: translation_glossary_id
        in: path
        required: true
        schema:
          title: Translation Glossary Id
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranslationGlossaryRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Translation Glossaries
      summary: Update Translation Glossary
      description: Updates a translation glossary.
      operationId: update_translation_glossary
      security:
      - HTTPBearer: []
      parameters:
      - name: translation_glossary_id
        in: path
        required: true
        schema:
          title: Translation Glossary Id
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranslationGlossaryUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranslationGlossaryRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Translation Glossaries
      summary: Delete Translation Glossary
      description: Deletes a translation glossary.
      operationId: delete_translation_glossary
      security:
      - HTTPBearer: []
      parameters:
      - name: translation_glossary_id
        in: path
        required: true
        schema:
          title: Translation Glossary Id
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InfinitePaginatedResponse_TranslationGlossaryRead_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TranslationGlossaryRead'
          type: array
          title: Data
        has_more:
          type: boolean
          title: Has More
        next_cursor:
          title: Next Cursor
          type: string
      type: object
      required:
      - data
      - has_more
      title: InfinitePaginatedResponse[TranslationGlossaryRead]
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    TranslationGlossaryUpdate:
      properties:
        term:
          title: Term
          description: The glossary term
          type: string
          maxLength: 255
        translation:
          title: Translation
          description: The translation of the glossary term
          type: string
          maxLength: 255
      type: object
      title: TranslationGlossaryUpdate
    TranslationGlossaryRead:
      properties:
        locale_id:
          type: string
          maxLength: 32
          title: Locale Id
          description: The unique identifier of the locale
        term:
          type: string
          maxLength: 255
          title: Term
          description: The glossary term
        translation:
          type: string
          maxLength: 255
          title: Translation
          description: The translation of the glossary term
        id:
          type: string
          maxLength: 32
          title: Id
          description: The unique identifier of the glossary
      type: object
      required:
      - locale_id
      - term
      - translation
      - id
      title: TranslationGlossaryRead
    TranslationGlossaryCreate:
      properties:
        locale_id:
          type: string
          maxLength: 32
          title: Locale Id
          description: The unique identifier of the locale
        term:
          type: string
          maxLength: 255
          title: Term
          description: The glossary term
        translation:
          type: string
          maxLength: 255
          title: Translation
          description: The translation of the glossary term
      type: object
      required:
      - locale_id
      - term
      - translation
      title: TranslationGlossaryCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      description: Refer to the [Authentication](https://docs.aghanim.com/api-reference/) section for instructions on obtaining an API key and use it as the `Bearer` token.