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

# Search a portal

> The pages, sections and rules of every brand it shows, from their latest publish, as far as this visitor may read: nothing hidden or locked is found. Every word must match, each as a prefix; each brand's best first, 20 at most. Beside them, up to 12 of its collections' assets.

No key needed.



## OpenAPI

````yaml /openapi.json get /api/v1/portal/{slug}/search
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/portal/{slug}/search:
    parameters:
      - name: slug
        in: path
        required: true
        description: The portal's address
        schema:
          type: string
    get:
      summary: Search a portal
      description: >-
        The pages, sections and rules of every brand it shows, from their latest
        publish, as far as this visitor may read: nothing hidden or locked is
        found. Every word must match, each as a prefix; each brand's best first,
        20 at most. Beside them, up to 12 of its collections' assets.


        No key needed.
      parameters:
        - name: q
          in: query
          schema:
            type: string
          description: Words to find
        - name: lang
          in: query
          schema:
            type: string
          description: Search the pages in this language
      responses:
        '200':
          description: Hits and assets
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      hits:
                        type: array
                        items:
                          type: object
                          properties:
                            kind:
                              type: string
                              enum:
                                - page
                                - section
                                - rule
                            brand:
                              type: string
                            page:
                              type: string
                            section:
                              description: 'The section''s id: its anchor on the page'
                              type: string
                            title:
                              type: string
                            snippet:
                              type: string
                              description: Plain text around the first word found
                            path:
                              type: string
                              description: >-
                                The page's path on the portal, e.g. /logo: the
                                first brand's pages sit at the top, the others
                                under their brand
                          required:
                            - kind
                            - brand
                            - page
                            - title
                            - snippet
                            - path
                          additionalProperties: false
                      assets:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            filename:
                              type: string
                            title:
                              type:
                                - string
                                - 'null'
                            description:
                              type:
                                - string
                                - 'null'
                            creator:
                              type:
                                - string
                                - 'null'
                            copyright:
                              type:
                                - string
                                - 'null'
                            mime:
                              type: string
                            size:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            width:
                              anyOf:
                                - type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                - type: 'null'
                            height:
                              anyOf:
                                - type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                - type: 'null'
                            thumbnail:
                              description: A URL on this host
                              type:
                                - string
                                - 'null'
                            preview:
                              description: Larger, for a closer look
                              type:
                                - string
                                - 'null'
                            downloads:
                              type: array
                              items:
                                type: object
                                properties:
                                  preset:
                                    type: string
                                    enum:
                                      - web
                                      - social
                                      - story
                                      - print
                                      - png
                                      - original
                                  label:
                                    type: string
                                  hint:
                                    type: string
                                  url:
                                    type: string
                                  filename:
                                    type: string
                                required:
                                  - preset
                                  - label
                                  - hint
                                  - url
                                  - filename
                                additionalProperties: false
                            original:
                              type: string
                              description: The file as uploaded
                            focus:
                              anyOf:
                                - type: object
                                  properties:
                                    x:
                                      type: number
                                    'y':
                                      type: number
                                  required:
                                    - x
                                    - 'y'
                                  additionalProperties: false
                                - type: 'null'
                              description: >-
                                Where a crop keeps its subject, from 0 to 1
                                across and down
                            updatedAt:
                              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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                          required:
                            - id
                            - filename
                            - title
                            - description
                            - creator
                            - copyright
                            - mime
                            - size
                            - width
                            - height
                            - thumbnail
                            - preview
                            - downloads
                            - original
                            - focus
                            - updatedAt
                          additionalProperties: false
                    required:
                      - hits
                      - assets
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '401':
          description: 'Not in yet: how to get in'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: password
                      message:
                        type: string
                      detail:
                        type: object
                        properties:
                          name:
                            type: string
                          access:
                            type: string
                            enum:
                              - password
                              - members
                          theme:
                            type: object
                            properties:
                              logo:
                                description: >-
                                  A URL on this host: the portal's, else its
                                  organization's
                                type:
                                  - string
                                  - 'null'
                              accent:
                                description: The portal's, else its organization's
                                type:
                                  - string
                                  - 'null'
                              background:
                                type:
                                  - string
                                  - 'null'
                              icon:
                                description: The organization's, for the browser tab
                                type:
                                  - string
                                  - 'null'
                              product:
                                type: string
                                description: What the organization calls the product
                            required:
                              - logo
                              - accent
                              - background
                              - icon
                              - product
                            additionalProperties: false
                        required:
                          - name
                          - access
                          - theme
                        additionalProperties: false
                    required:
                      - code
                      - message
                      - detail
                    additionalProperties: false
                required:
                  - error
                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
      security: []
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

````