Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Dependencies

No additional dependencies - uses requests (included). For credential setup, see the Paperclip Setup guide.

​
Configuration

from mirage import MountMode, Workspace
from mirage.resource.paperclip import PaperclipConfig, PaperclipResource

config = PaperclipConfig()
resource = PaperclipResource(config=config)
ws = Workspace({"/paperclip": resource}, mode=MountMode.READ)

​
Config Reference

FieldRequiredDefaultDescription
base_urlNohttps://paperclip.gxl.aiPaperclip API base URL
credentials_pathNo~/.paperclip/credentials.jsonPath to credentials file
default_limitNo500Max papers returned per listing

​
Custom Server

For self-hosted Paperclip instances, override base_url and point credentials_path to the credentials file issued by your server: 
from mirage import MountMode, Workspace
from mirage.resource.paperclip import PaperclipConfig, PaperclipResource

config = PaperclipConfig(
    base_url="https://paperclip.internal.example.com",
    credentials_path="~/.paperclip/internal-credentials.json",
)
resource = PaperclipResource(config=config)
ws = Workspace({"/paperclip": resource}, mode=MountMode.READ)