PARACOSM AGENTOS | API Reference v0.9.1035
Home Simulation API Docs GitHub npm
Home Simulation API Docs GitHub npm AgentOS Discord
paracosm - v0.9.1035
    Preparing search index...

    Interface CompileOptions

    Options for compileScenario().

    interface CompileOptions {
        anthropicKey?: string;
        apiKey?: string;
        braveKey?: string;
        cache?: boolean;
        cacheDir?: string;
        cohereKey?: string;
        firecrawlKey?: string;
        generateText?: GenerateTextFn;
        maxSearches?: number;
        model?: string;
        onProgress?: (
            hookName: string,
            status: "generating" | "cached" | "done" | "fallback",
        ) => void;
        provider?: LlmProvider;
        seedText?: string;
        seedUrl?: string;
        serperKey?: string;
        tavilyKey?: string;
        telemetry?: CompilerTelemetry;
        webSearch?: boolean;
    }

    Hierarchy

    • RuntimeCredentialOptions
      • CompileOptions
    Index
    anthropicKey? apiKey? braveKey? cache? cacheDir? cohereKey? firecrawlKey? generateText? maxSearches? model? onProgress? provider? seedText? seedUrl? serperKey? tavilyKey? telemetry? webSearch?
    anthropicKey?: string

    Anthropic API key.

    apiKey?: string

    OpenAI API key. Historical dashboard field name.

    braveKey?: string
    cache?: boolean

    Whether to use disk caching. Default: true.

    cacheDir?: string

    Base directory for the disk cache. Default: '.paracosm/cache'.

    cohereKey?: string
    firecrawlKey?: string
    generateText?: GenerateTextFn

    Custom generateText function (overrides provider/model).

    maxSearches?: number

    Max web searches during seed ingestion. Default: 5.

    model?: string

    Model name for hook generation.

    onProgress?: (
        hookName: string,
        status: "generating" | "cached" | "done" | "fallback",
    ) => void

    Progress callback for each hook being generated.

    provider?: LlmProvider

    LLM provider to use for hook generation.

    seedText?: string

    Prompt, brief, or document text to ingest into the scenario's knowledge bundle via LLM extraction + optional web search.

    seedUrl?: string

    URL to fetch and ingest as source material. If set, seedText is ignored.

    serperKey?: string
    tavilyKey?: string
    telemetry?: CompilerTelemetry

    Optional telemetry sink that collects per-hook attempt counts and any exhausted-retry fallbacks. Use when you want to surface compile reliability in a dashboard or snapshot into /retry-stats. See CompilerTelemetry.

    webSearch?: boolean

    Enable live web search during seed ingestion. Requires search API keys. Default: true.

    Settings
    Member Visibility

    On This Page
    Properties
    agentos.sh GitHub npm Frame.dev Frame Privacy
    PARACOSM · Apache-2.0 · Frame.dev