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

# Read a workspace artifact

> One artifact from the calling user's workspace. Text artifacts carry their decoded content (capped — `truncated` marks a clipped read); binary artifacts return metadata only, with the bytes available from the raw endpoint. The path is the workspace path with each segment URL-encoded, e.g. /file/recon%2FINDEX.md.



## OpenAPI

````yaml /api/openapi.json get /api/workspace/file/{file}
openapi: 3.1.0
info:
  title: Aquila API
  version: 1.0.0
  description: >-
    Event-driven reconnaissance platform API. All /api/* routes except
    /api/public/* require an authenticated session (cookie), an X-Api-Key
    header, or a bearer token. Auth endpoints under /api/auth/* are generated by
    Better Auth.
servers:
  - url: https://aquila.attaxr.com
  - url: http://localhost
security: []
tags:
  - name: AI
  - name: Agents
  - name: Bulk Delete
  - name: Chat
  - name: Constraints
  - name: Dashboard
  - name: Events
  - name: JS
  - name: JS Analysis
  - name: JS Monitoring
  - name: Leads
  - name: MCP Key
  - name: Models
  - name: Notification Channels
  - name: Notification Event Preferences
  - name: Notifications
  - name: OOB
  - name: Provider Keys
  - name: Public Shares
  - name: Reinforcements
  - name: Reports
  - name: Scans
  - name: Schedules
  - name: Shares
  - name: Tools
  - name: User Profiles
  - name: V1
  - name: Vulnerabilities
  - name: Workflows
  - name: Workspace
paths:
  /api/workspace/file/{file}:
    get:
      tags:
        - Workspace
      summary: Read a workspace artifact
      description: >-
        One artifact from the calling user's workspace. Text artifacts carry
        their decoded content (capped — `truncated` marks a clipped read);
        binary artifacts return metadata only, with the bytes available from the
        raw endpoint. The path is the workspace path with each segment
        URL-encoded, e.g. /file/recon%2FINDEX.md.
      operationId: getApiWorkspaceFileFile
      parameters:
        - name: file
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The artifact.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  path:
                    type: string
                  name:
                    type: string
                  mimeType:
                    type: string
                  kind:
                    type: string
                    enum:
                      - text
                      - binary
                  modifiedAt:
                    type: string
                  size:
                    type: number
                  content:
                    type: string
                  truncated:
                    type: boolean
                required:
                  - path
                  - name
                  - mimeType
                  - kind
                  - modifiedAt
                additionalProperties: false
        '400':
          description: Invalid artifact path.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '401':
          description: No valid session cookie or API key.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: No artifact at this path.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '502':
          description: The artifact read failed.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '503':
          description: Workspace storage is not provisioned.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - apiKeyCookie: []
        - apiKeyHeader: []
        - bearerAuth: []
components:
  securitySchemes:
    apiKeyCookie:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Browser session cookie set by Better Auth sign-in.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Personal API key (aquila_… prefix; settings → API keys).
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal API key sent as a bearer token.

````