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

# The workspace's file index (workspace-relative R2 keys)



## OpenAPI

````yaml /openapi.json get /api/workspaces/{id}/files
openapi: 3.1.0
info:
  title: Syvon API
  version: 1.0.0
  description: >-
    Two client-facing surfaces: the Portal management plane (syvon.ai/api/*,
    portal JWT) and the Brain read plane (brain.syvon.ai/v1/*, workspace key
    sk_ws_…). Schemas are generated from the @syvon/sdk TypeScript types — the
    shipped .d.ts files are the authoritative contract.
servers:
  - url: https://syvon.ai
    description: Portal (management plane)
  - url: https://brain.syvon.ai
    description: Brain (read plane)
security: []
tags:
  - name: Auth
    description: Minting the portal JWT
  - name: Portal
    description: Management plane — user-scoped (portal JWT)
  - name: Brain
    description: Published-agent read plane — workspace-scoped (sk_ws_…)
paths:
  /api/workspaces/{id}/files:
    get:
      tags:
        - Portal
      summary: The workspace's file index (workspace-relative R2 keys)
      operationId: listFiles
      parameters:
        - name: id
          in: path
          required: true
          description: Workspace id
          schema:
            type: string
        - name: prefix
          in: query
          required: false
          description: Filter by key prefix
          schema:
            type: string
      responses:
        '200':
          description: File index
          content:
            application/json:
              schema:
                type: object
                properties:
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        size:
                          type: number
                        mimeType:
                          type: string
                      required:
                        - key
                required:
                  - files
      security:
        - bearerAuth: []
      servers:
        - url: https://syvon.ai
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Portal API JWT (user-scoped, ~1h)

````