ABMeter Variants API

openapi: 3.2.0
info:
  title: Abmeter Ai Variants API
  version: 1.0.0
  contact:
    name: ABMeter Support
    email: info@abmeter.com
  license:
    name: Commercial
    url: https://abmeter.ai/terms
  description: 'Operations tagged Variants across 2 of this provider''s published API definitions: spec.yaml, abmeter-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://abmeter.ai/api/v1
  description: ABMeter API
security:
- bearerAuth: []
tags:
- name: Variants
paths:
  /variants:
    get:
      summary: List all variants
      description: Retrieve a list of all variants, optionally filtered by space. Variants represent different configurations with specific parameter values that can be used in experiments and feature flags.
      security:
      - bearerAuth: []
      parameters:
      - name: space_slug
        in: query
        schema:
          $ref: '#/components/schemas/Slug'
        required: false
        description: Filter variants by space slug
      responses:
        '200':
          description: List of variants
          content:
            application/json:
              example:
              - created_at: '2026-01-30T12:00:00Z'
                description: null
                parameter_values:
                  parameter-welcome-message: We are glad to see you!
                  parameter-welcome-image: big-exclamation-mark.png
                slug: welcome-page-different-greetings
                space_slug: main
                updated_at: '2026-01-30T12:00:00Z'
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Variant'
      tags:
      - Variants
      operationId: getVariants
      x-operation-id-source: derived
    post:
      summary: Create a new variant
      description: Create a new variant with specific parameter values within a space. The variant can then be used in experiments and feature flags to represent different user experiences.
      security:
      - bearerAuth: []
      parameters: []
      responses:
        '201':
          description: Variant created successfully
        '400':
          description: Bad request
          content:
            application/json:
              example:
                error: Bad request
                status: 400
                details:
                  slug:
                  - can only contain lowercase letters, numbers and hyphens
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Variant'
              example:
                slug: variant-personalized-welcome
                description: Variant with personalized welcome message
                space_slug: main
                parameter_values:
                  parameter-welcome-message: Welcome back, {user_name}!
      tags:
      - Variants
      operationId: postVariants
      x-operation-id-source: derived
    servers:
    - url: https://abmeter.ai/api/v1
      description: ABMeter API
  /variants/{variant_slug}:
    parameters:
    - name: variant_slug
      in: path
      schema:
        $ref: '#/components/schemas/Slug'
      description: The unique identifier of the variant
      required: true
    - name: space_slug
      in: query
      schema:
        $ref: '#/components/schemas/Slug'
      required: false
      description: 'Space slug (default: main)'
    get:
      summary: Get a specific variant
      description: Retrieve detailed information about a specific variant by its slug, including all parameter values and configuration details.
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Variant details
          content:
            application/json:
              example:
                created_at: '2026-01-30T12:00:00Z'
                description: null
                parameter_values:
                  parameter-welcome-message: We are glad to see you!
                  parameter-welcome-image: big-exclamation-mark.png
                slug: welcome-page-different-greetings
                space_slug: main
                updated_at: '2026-01-30T12:00:00Z'
              schema:
                $ref: '#/components/schemas/Variant'
        '404':
          description: Variant not found
          content:
            application/json:
              example:
                error: Variant 'non-existent' not found in space 'main'
                status: 404
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Variants
      operationId: getVariantsByVariantSlug
      x-operation-id-source: derived
    put:
      summary: Update a variant
      description: Update an existing variant with new parameter values and configuration. This replaces the entire variant configuration with the provided data.
      security:
      - bearerAuth: []
      parameters: []
      responses:
        '200':
          description: Variant updated successfully
          content:
            application/json:
              example:
                created_at: '2026-01-30T12:00:00Z'
                description: Updated description
                parameter_values:
                  parameter-welcome-message: new-value
                  parameter-welcome-image: new-image.png
                slug: welcome-page-different-greetings
                space_slug: main
                updated_at: '2026-01-30T12:00:00Z'
              schema:
                $ref: '#/components/schemas/Variant'
        '404':
          description: Variant not found
          content:
            application/json:
              example:
                error: Variant 'non-existent' not found in space 'main'
                status: 404
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Variant'
              example:
                description: Updated description
                parameter_values:
                  parameter-welcome-message: new-value
                  parameter-welcome-image: new-image.png
      tags:
      - Variants
      operationId: putVariantsByVariantSlug
      x-operation-id-source: derived
    delete:
      summary: Delete a variant
      description: Permanently delete a variant. This action cannot be undone and will remove the variant from all associated experiments and feature flags.
      security:
      - bearerAuth: []
      responses:
        '204':
          description: Variant deleted successfully
        '404':
          description: Variant not found
          content:
            application/json:
              example:
                error: Variant 'non-existent' not found in space 'main'
                status: 404
      tags:
      - Variants
      operationId: deleteVariantsByVariantSlug
      x-operation-id-source: derived
    servers:
    - url: https://abmeter.ai/api/v1
      description: ABMeter API
components:
  schemas:
    Error:
      type: object
      description: 'Standard error response format for all API endpoints


        **Important:** The response is ALWAYS an object/hash, never null or any other type.

        The `details` field, when present, is ALWAYS an object/hash (e.g., `{}` not `null` or `[]`).

        The `details` field may be omitted when there are no additional details to provide.'
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Machine-readable error code (optional)
        details:
          type: object
          description: 'Additional error details. When present, ALWAYS an object/hash.

            May contain field-specific errors or other structured information.

            Examples: `{"name": ["can''t be blank"]}` for validation errors, `{"message": "Invalid state"}` for other errors'
          additionalProperties: true
      required:
      - error
    Slug:
      type: string
      description: 'Standardized identifier for entities used across the API. Recommended format: each entity type has its own prefix pattern followed by a short alphanumeric identifier (e.g., parameter-ab4c, space-main, audience-control).'
    Variant:
      type: object
      description: Named set of parameter value overrides for experiments or feature flags
      properties:
        slug:
          $ref: '#/components/schemas/Slug'
        description:
          type:
          - string
          - 'null'
        parameter_values:
          type: object
          additionalProperties:
            oneOf:
            - type: string
            - type: boolean
            - type: number
          description: Parameter slug to value mappings for this variant
        space_slug:
          $ref: '#/components/schemas/Slug'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - slug
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the ABMeter dashboard. Pass it in the Authorization header with 'Bearer' prefix.
x-refined-from:
- spec.yaml
- abmeter-ai-openapi.yml