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

# Get

> Read one creative style (or the toolkit styles run on): its description, current version, sha256 and examples

CLI: `adside creative-styles get`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/creative-styles/{slug}
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/creative-styles/{slug}:
    get:
      tags:
        - Creative styles
      summary: Get
      description: >-
        Read one creative style (or the toolkit styles run on): its description,
        current version, sha256 and examples


        CLI: `adside creative-styles get`
      operationId: creative-styles.get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: slug
          in: path
          required: true
          schema:
            type: string
            minLength: 2
            maxLength: 60
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  style:
                    type: object
                    properties:
                      slug:
                        type: string
                        minLength: 2
                        maxLength: 60
                        pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                      kind:
                        type: string
                        enum:
                          - style
                          - toolkit
                      status:
                        type: string
                        enum:
                          - draft
                          - active
                      name:
                        type: string
                      summary:
                        type: string
                      description:
                        type: string
                      version:
                        type: string
                        pattern: ^(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})$
                      sha256:
                        type: string
                        pattern: ^[0-9a-f]{64}$
                      sizeBytes:
                        type: integer
                        exclusiveMinimum: 0
                        maximum: 9007199254740991
                      skills:
                        type: array
                        items:
                          type: string
                          minLength: 2
                          maxLength: 60
                          pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                      requirements:
                        type: object
                        properties:
                          media:
                            type: array
                            items:
                              type: string
                              enum:
                                - image
                                - video
                                - speech
                                - sound
                                - music
                                - avatar
                                - lipsync
                          tools:
                            type: array
                            items:
                              type: string
                              enum:
                                - node
                                - python3
                                - ffmpeg
                                - chromium
                        required:
                          - media
                          - tools
                        additionalProperties: false
                      toolkit:
                        anyOf:
                          - type: object
                            properties:
                              slug:
                                type: string
                                minLength: 2
                                maxLength: 60
                                pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                              range:
                                type: string
                                pattern: >-
                                  ^\^(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})$
                            required:
                              - slug
                              - range
                            additionalProperties: false
                          - type: 'null'
                      examples:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                              maxLength: 64
                            title:
                              type: string
                              minLength: 1
                              maxLength: 200
                            brand:
                              type: string
                              minLength: 1
                              maxLength: 100
                            format:
                              type: string
                              enum:
                                - static
                                - video
                            imageUrl:
                              type: string
                              maxLength: 2048
                              format: uri
                            contactSheetUrl:
                              type: string
                              maxLength: 2048
                              format: uri
                            videoUrl:
                              type: string
                              maxLength: 2048
                              format: uri
                            version:
                              type: string
                              pattern: >-
                                ^(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})\.(0|[1-9]\d{0,5})$
                            mediaCostUsd:
                              type: number
                              minimum: 0
                              maximum: 1000
                          required:
                            - id
                            - title
                            - brand
                            - format
                            - imageUrl
                            - version
                          additionalProperties: false
                      publishedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    required:
                      - slug
                      - kind
                      - status
                      - name
                      - summary
                      - description
                      - version
                      - sha256
                      - sizeBytes
                      - skills
                      - requirements
                      - toolkit
                      - examples
                      - publishedAt
                    additionalProperties: false
                required:
                  - style
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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