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

# Browse an icon set

> A page of the set's icons, each drawn as the SVG an import would store, and its categories to narrow by.

Scope: `read`.



## OpenAPI

````yaml /openapi.json get /api/v1/icons/{prefix}
openapi: 3.1.0
info:
  title: artbucket
  version: '1'
  description: >-
    Agent-first asset management. The web UI is built on this API and nothing
    else, beside signing in at /api/auth. Send `Authorization: Bearer <key>`: a
    key works in one workspace with one scope, and scopes are a ladder: read <
    propose < write < admin. People signed in to the app carry a session cookie
    instead, and their scope is what their grants add up to: on the
    organization, the workspace, or single collections and assets. A scope shown
    as needed on the workspace is also enough on the one collection or asset a
    route acts on. Agents (MCP at POST /api/v1/mcp) usually get `propose`: what
    they add waits for a human.
servers:
  - url: http://localhost:3000
security:
  - bearer: []
  - session: []
  - {}
paths:
  /api/v1/icons/{prefix}:
    parameters:
      - name: prefix
        in: path
        required: true
        description: 'The set, as Iconify names it: tabler, lucide, simple-icons'
        schema:
          type: string
    get:
      summary: Browse an icon set
      description: >-
        A page of the set's icons, each drawn as the SVG an import would store,
        and its categories to narrow by.


        Scope: `read`.
      parameters:
        - name: q
          in: query
          schema:
            type: string
          description: Words in the icon's name
        - name: category
          in: query
          schema:
            type: string
          description: One of the set's categories
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Icons to skip
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 96
          description: Page size
      responses:
        '200':
          description: The set and a page of its icons
          content:
            application/json:
              schema:
                type: object
                properties:
                  set:
                    type: object
                    properties:
                      prefix:
                        type: string
                        description: 'Iconify''s name for it: tabler, lucide, simple-icons'
                      name:
                        type: string
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: Icons in it
                      author:
                        anyOf:
                          - type: object
                            properties:
                              name:
                                type: string
                              url:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: 'null'
                      license:
                        anyOf:
                          - type: object
                            properties:
                              title:
                                type: string
                              spdx:
                                type: string
                              url:
                                type: string
                            required:
                              - title
                            additionalProperties: false
                          - type: 'null'
                      samples:
                        type: array
                        items:
                          type: string
                        description: A few of its icons' names
                      category:
                        type:
                          - string
                          - 'null'
                      palette:
                        type: boolean
                        description: >-
                          Its icons carry their own colors; false: drawn in one
                          color
                      height:
                        description: The grid it is drawn on, in px
                        type:
                          - number
                          - 'null'
                    required:
                      - prefix
                      - name
                      - total
                      - author
                      - license
                      - samples
                      - category
                      - palette
                      - height
                    additionalProperties: false
                  categories:
                    type: array
                    items:
                      type: string
                    description: The set's own categories, to narrow by
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Matching icons before `offset` and `limit`
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        svg:
                          type: string
                          description: The file an import stores
                      required:
                        - name
                        - svg
                      additionalProperties: false
                required:
                  - set
                  - categories
                  - total
                  - data
                additionalProperties: false
        default:
          description: An error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      detail: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'An API key: ab_...'
    session:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Signed in, at /api/auth

````