Constructors

Methods

  • Unified cross-title "needs you" inbox (open guidance + pending approvals across all titles).

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Cross-title agency cockpit: per-title agent status, billing/credits, and portfolio totals.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Answer a guidance request and write structured agent memory.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • guidance_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Approve an agent action.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • action_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Cancel a title-agent subscription linked to a community title.

    Type Parameters

    • T

    Parameters

    • community_id: string
    • stripe_subscription_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Request cancellation for a queued or running agent run.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • run_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Create an agent before payment. Runs/results remain gated until subscription or prepaid credits.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Create a scheduler inline from an agent setup flow.

    Type Parameters

    • T

    Parameters

    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get the prepaid agent credit balance and ledger (Pay-As-You-Go plan).

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Archive an agent.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Execute an approved safe action.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • action_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Mark a queued or running agent run as being watched live so the UI can stream the loop and the backend can avoid sending delayed background summaries to active viewers.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • run_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Send a course correction to a queued or running agent run.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • run_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List agent actions/approval queue for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List agents for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List title-agent subscriptions linked to titles in a community.

    Type Parameters

    • T

    Parameters

    • community_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List guidance requests where agents have stopped for developer direction.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List structured agent memories for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List real-time user-visible events for an agent run.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • run_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List agent runs for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List social/ad schedulers. Useful when agent setup needs to attach to an existing workflow.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List game titles that can be managed in the Agents section.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Buy prepaid agent credits (Pay-As-You-Go). Charges the card up front; the agent draws down credits per run and stops when they run out. data: { paymentMethod, amount_usd }.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Reject an agent action.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • action_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get results and outcome summary for title agents. Returns 402 until subscription or prepaid credits are active.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Rewrite an editable agent draft for review without executing the parent action.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Return the full Laravel API route catalog agents use for route-aware planning.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Run an agent planning cycle. Returns 402 when subscription or prepaid credits are required.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • Optional data: AgentRunRequest
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Start a Stripe-backed agent subscription after setup.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Update an agent's setup, policies, and guidance stop rules.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Upload one file for an agent run. data can include { agent_run_id }.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • file: Blob | File
    • Optional data: object
    • Optional params: Record<string, any>
    • Optional onUploadProgress: ((progressEvent) => void)
        • (progressEvent): void
        • Parameters

          • progressEvent: AxiosProgressEvent

          Returns void

    Returns AxiosPromise<default<T>>

  • Alias for callers that use plural naming while uploading one file at a time.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • file: Blob | File
    • Optional data: object
    • Optional params: Record<string, any>
    • Optional onUploadProgress: ((progressEvent) => void)
        • (progressEvent): void
        • Parameters

          • progressEvent: AxiosProgressEvent

          Returns void

    Returns AxiosPromise<default<T>>

  • Get this title's agent usage against plan limits (agents used/included, monthly runs, and AI dollars spent vs the configured monthly AI budget). Powers usage meters and limit warnings.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • View one agent.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • agent_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • View one durable agent run, including events, files, actions, and guidance when loaded by the API.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • run_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get a title-scoped agent workspace with setup, billing, counts, and route summary.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Generated using TypeDoc