Anchorage API reference
    Preparing search index...

    Interface ObjectiveRouterOptions

    interface ObjectiveRouterOptions {
        audit?: ObjectiveAuditSink;
        basePath?: string;
        executionFence: ExecutionFenceWiring;
        maxContentBytes?: number;
        maxRunsCap?: number;
        resolve: ActorResolver;
        roles?: readonly ApprovalRole[];
        store: ObjectiveStore;
        validateThreadTarget: BoundThreadTargetValidator;
    }
    Index

    Properties

    audit? basePath? executionFence maxContentBytes? maxRunsCap? resolve roles? store validateThreadTarget

    Properties

    audit?: ObjectiveAuditSink

    Every mutation (and denied read) is audited through this. Absent ⇒ no audit.

    basePath?: string

    Route prefix. Default '/api/threads' (goals mount at /:threadId/goal).

    executionFence: ExecutionFenceWiring

    The deployment execution fence, or 'none' for a router with no database behind it. A standing objective is authored work — it is what the agent loop re-reads to decide it should run again — so SET and UPDATE are refused past open. CLEAR stays available in every state because it removes a standing instruction rather than arming one (the same reason schedule pause and delete are exempt), and GET stays available in every state.

    REQUIRED: this router receives a store facade, not a database, so the host is the only place the wiring can happen. See ExecutionFenceWiring.

    maxContentBytes?: number

    Max raw request-body size in bytes. Must be a nonnegative safe integer; zero denies every non-empty body. Default 16384.

    maxRunsCap?: number

    The ceiling on a per-objective maxRuns. A request above it is REJECTED; the stored record never carries a higher value. Default the core DEFAULT_GOAL_MAX_RUNS (50). Must be a positive safe integer.

    resolve: ActorResolver

    Authenticate and validate the actor; undefined means 401.

    roles?: readonly ApprovalRole[]

    Who may SET/UPDATE/CLEAR an objective. Default RUN_START_ROLES (operator/admin) — reviewers/viewers cannot author standing instructions. Reads (GET) are not role-gated beyond ownership.

    store: ObjectiveStore

    The thread-state domain in which the goal record lives.

    validateThreadTarget: BoundThreadTargetValidator

    Prove mutations target durable bound memory, not an ephemeral run id.

    Settings

    Member Visibility

    On This Page

    Properties