> ## 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.

# List

> List the workspace's artifacts: the documents, one-pagers and dashboards the agent has written, most recently changed first. Leaves out unlisted ones, which open by their link

CLI: `adside artifacts list`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/artifacts
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}/artifacts:
    get:
      tags:
        - Artifacts
      summary: List
      description: >-
        List the workspace's artifacts: the documents, one-pagers and dashboards
        the agent has written, most recently changed first. Leaves out unlisted
        ones, which open by their link


        CLI: `adside artifacts list`
      operationId: artifacts.list
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: offset
          in: query
          required: false
          schema:
            default: 0
            type: integer
            minimum: 0
            maximum: 100000
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  artifacts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        url:
                          type: string
                        chatThreadId:
                          type: string
                        originChatThreadId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        listed:
                          type: boolean
                        threadStatus:
                          type: string
                          enum:
                            - generating
                            - completed
                        currentVersion:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                number:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                entryPath:
                                  type: string
                                byteSize:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                fileCount:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                kitVersion:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                thumbnailAssetId:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                dataAsOf:
                                  anyOf:
                                    - type: string
                                      format: date
                                      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])))$
                                    - type: 'null'
                                summary:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                publishedAt:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                createdAt:
                                  type: string
                                createdById:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                createdByName:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                changeType:
                                  type: string
                                  enum:
                                    - GENERATION
                                    - RESTORE
                                restoredFromNumber:
                                  anyOf:
                                    - type: integer
                                      minimum: -9007199254740991
                                      maximum: 9007199254740991
                                    - type: 'null'
                              required:
                                - id
                                - number
                                - entryPath
                                - byteSize
                                - fileCount
                                - kitVersion
                                - thumbnailAssetId
                                - dataAsOf
                                - summary
                                - publishedAt
                                - createdAt
                                - createdById
                                - createdByName
                                - changeType
                                - restoredFromNumber
                              additionalProperties: false
                            - type: 'null'
                        publishedVersion:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                number:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                entryPath:
                                  type: string
                                byteSize:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                fileCount:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                kitVersion:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                thumbnailAssetId:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                dataAsOf:
                                  anyOf:
                                    - type: string
                                      format: date
                                      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])))$
                                    - type: 'null'
                                summary:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                publishedAt:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                createdAt:
                                  type: string
                                createdById:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                createdByName:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                changeType:
                                  type: string
                                  enum:
                                    - GENERATION
                                    - RESTORE
                                restoredFromNumber:
                                  anyOf:
                                    - type: integer
                                      minimum: -9007199254740991
                                      maximum: 9007199254740991
                                    - type: 'null'
                              required:
                                - id
                                - number
                                - entryPath
                                - byteSize
                                - fileCount
                                - kitVersion
                                - thumbnailAssetId
                                - dataAsOf
                                - summary
                                - publishedAt
                                - createdAt
                                - createdById
                                - createdByName
                                - changeType
                                - restoredFromNumber
                              additionalProperties: false
                            - type: 'null'
                        publishedBehindBy:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        versionCount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        createdById:
                          anyOf:
                            - type: string
                            - type: 'null'
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - title
                        - url
                        - chatThreadId
                        - originChatThreadId
                        - listed
                        - threadStatus
                        - currentVersion
                        - publishedVersion
                        - publishedBehindBy
                        - versionCount
                        - createdById
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  hasMore:
                    type: boolean
                required:
                  - artifacts
                  - hasMore
                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.