Class default

Constructors

constructor

new default(): default
Returns default

Methods

`Static` agencyInbox

agencyInbox<T>(params?): AxiosPromise<default<T>>
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>>
- Defined in src/api/Agents.ts:458

`Static` agencyOverview

agencyOverview<T>(params?): 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>>
- Defined in src/api/Agents.ts:451

`Static` answerGuidance

answerGuidance<T>(title_id, guidance_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:330

`Static` approveAction

approveAction<T>(title_id, action_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:302

`Static` attachGoogleDriveFile

attachGoogleDriveFile<T>(title_id, agent_id, data?, params?): AxiosPromise<default<T>>
Attach a Google Drive file as a reference file for an agent.
Type Parameters
- T
Parameters
- title_id: string
- agent_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:215

`Static` cancelCommunitySubscription

cancelCommunitySubscription<T>(community_id, stripe_subscription_id, params?): 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>>
- Defined in src/api/Agents.ts:84

`Static` cancelRun

cancelRun<T>(title_id, run_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:281

`Static` createAccessKeys

createAccessKeys<T>(title_id, data, params?): AxiosPromise<default<T>>
Agent workflow convenience wrapper for saving manual access keys.
Type Parameters
- T
Parameters
- title_id: string
- data: {
  codes: string;
  platform: string;
  }
  - codes: string
  - platform: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:372

`Static` createAgent

createAgent<T>(title_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:112

`Static` createScheduler

createScheduler<T>(data?, params?): 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>>
- Defined in src/api/Agents.ts:444

`Static` creatorInviteContext

creatorInviteContext<T>(campaign_id, params?): AxiosPromise<default<T>>
Agent workflow convenience wrapper for creator invite context.
Type Parameters
- T
Parameters
- campaign_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:344

`Static` credits

credits<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:415

`Static` deactivateMemory

deactivateMemory<T>(title_id, memory_id, params?): AxiosPromise<default<T>>
Deactivate one structured agent memory.
Type Parameters
- T
Parameters
- title_id: string
- memory_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:393

`Static` deleteAgent

deleteAgent<T>(title_id, agent_id, params?): 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>>
- Defined in src/api/Agents.ts:133

`Static` downloadAgentFile

downloadAgentFile(title_id, file_id, options?): Promise<Response>
Download a protected agent file through the authenticated API route.

Returns the native Fetch API Response so callers can inspect headers such as Content-Disposition before creating a browser download or preview blob.
Parameters
- title_id: string
- file_id: string
- options: AgentFetchOptions = {}
Returns Promise<Response>
- Defined in src/api/Agents.ts:225

`Static` executeAction

executeAction<T>(title_id, action_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:316

`Static` exportAgentFileToGoogleDrive

exportAgentFileToGoogleDrive<T>(title_id, file_id, data?, params?): AxiosPromise<default<T>>
Export a generated agent artifact to Google Drive.
Type Parameters
- T
Parameters
- title_id: string
- file_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:245

`Static` `Private` fetchWithAuth

fetchWithAuth(path, init, options?): Promise<Response>
Parameters
- path: string
- init: RequestInit
- options: AgentFetchOptions = {}
Returns Promise<Response>
- Defined in src/api/Agents.ts:37

`Static` heartbeatRun

heartbeatRun<T>(title_id, run_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:274

`Static` interjectRun

interjectRun<T>(title_id, run_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:288

`Static` listActions

listActions<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:295

`Static` listAgents

listAgents<T>(title_id, params?): AxiosPromise<default<T>>
List agents for a title.
Type Parameters
- T
Parameters
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:105

`Static` listCommunitySubscriptions

listCommunitySubscriptions<T>(community_id, params?): 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>>
- Defined in src/api/Agents.ts:77

`Static` listGoogleDriveFiles

listGoogleDriveFiles<T>(title_id, params?): AxiosPromise<default<T>>
List Google Drive files/folders available to attach to a title agent.
Type Parameters
- T
Parameters
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:208

`Static` listGuidance

listGuidance<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:323

`Static` listMemories

listMemories<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:379

`Static` listRunEvents

listRunEvents<T>(title_id, run_id, params?): 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>>
- Defined in src/api/Agents.ts:266

`Static` listRuns

listRuns<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:252

`Static` listSchedulers

listSchedulers<T>(params?): 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>>
- Defined in src/api/Agents.ts:437

`Static` listTitles

listTitles<T>(params?): 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>>
- Defined in src/api/Agents.ts:70

`Static` purchaseCredits

purchaseCredits<T>(title_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:423

`Static` rejectAction

rejectAction<T>(title_id, action_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:309

`Static` results

results<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:400

`Static` rewriteAgentDraft

rewriteAgentDraft<T>(title_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:337

`Static` routeCatalog

routeCatalog<T>(params?): 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>>
- Defined in src/api/Agents.ts:91

`Static` runAgent

runAgent<T>(title_id, agent_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:140

`Static` sendCreatorInvite

sendCreatorInvite<T>(campaign_id, data?, params?): AxiosPromise<default<T>>
Agent workflow convenience wrapper for sending a reviewed creator invite.
Type Parameters
- T
Parameters
- campaign_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:351

`Static` startTrial

startTrial<T>(title_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:430

`Static` streamAnswer

streamAnswer(title_id, agent_id, data, options?): Promise<Response>
Stream a quick advisory answer for the agent workspace.

This returns the native Fetch API Response so callers can consume the ReadableStream body incrementally. A 409 response means streaming is disabled server-side and the caller should fall back to the normal run flow.
Parameters
- title_id: string
- agent_id: string
- data: string | AgentStreamAnswerRequest
- options: AgentStreamAnswerOptions = {}
Returns Promise<Response>
- Defined in src/api/Agents.ts:152

`Static` updateAgent

updateAgent<T>(title_id, agent_id, data?, params?): 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>>
- Defined in src/api/Agents.ts:126

`Static` updateCampaign

updateCampaign<T>(campaign_id, data?, params?): AxiosPromise<default<T>>
Agent workflow convenience wrapper for updating campaign settings.
Type Parameters
- T
Parameters
- campaign_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:365

`Static` updateMemory

updateMemory<T>(title_id, memory_id, data?, params?): AxiosPromise<default<T>>
Update one structured agent memory.
Type Parameters
- T
Parameters
- title_id: string
- memory_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:386

`Static` updateSocialPost

updateSocialPost<T>(post_id, data?, params?): AxiosPromise<default<T>>
Agent workflow convenience wrapper for updating a drafted social post.
Type Parameters
- T
Parameters
- post_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/Agents.ts:358

`Static` uploadAgentFile

uploadAgentFile<T>(title_id, agent_id, file, data?, params?, onUploadProgress?): 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>>
- Defined in src/api/Agents.ts:176

`Static` uploadAgentFiles

uploadAgentFiles<T>(title_id, agent_id, file, data?, params?, onUploadProgress?): 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>>
- Defined in src/api/Agents.ts:194

`Static` usage

usage<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:408

`Static` viewAgent

viewAgent<T>(title_id, agent_id, params?): 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>>
- Defined in src/api/Agents.ts:119

`Static` viewRun

viewRun<T>(title_id, run_id, params?): 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>>
- Defined in src/api/Agents.ts:259

`Static` workspace

workspace<T>(title_id, params?): 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>>
- Defined in src/api/Agents.ts:98

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static agencyInbox

Type Parameters

T

Parameters

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static agencyOverview

Type Parameters

T

Parameters

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static answerGuidance

Type Parameters

T

Parameters

title_id: string

guidance_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static approveAction

Type Parameters

T

Parameters

title_id: string

action_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static attachGoogleDriveFile

Type Parameters

T

Parameters

title_id: string

agent_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static cancelCommunitySubscription

Type Parameters

T

Parameters

community_id: string

stripe_subscription_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static cancelRun

Type Parameters

T

Parameters

title_id: string

run_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static createAccessKeys

Type Parameters

T

Parameters

title_id: string

data: { codes: string; platform: string; }

codes: string

platform: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static createAgent

Type Parameters

T

Parameters

title_id: string

Optional data: object

`Static` agencyInbox

`Optional` params: Record<string, any>

`Static` agencyOverview

`Optional` params: Record<string, any>

`Static` answerGuidance

`Optional` data: object

`Optional` params: Record<string, any>

`Static` approveAction

`Optional` data: object

`Optional` params: Record<string, any>

`Static` attachGoogleDriveFile

`Optional` data: object

`Optional` params: Record<string, any>

`Static` cancelCommunitySubscription

`Optional` params: Record<string, any>

`Static` cancelRun

`Optional` data: object

`Optional` params: Record<string, any>

`Static` createAccessKeys

data: {
codes: string;
platform: string;
}

`Optional` params: Record<string, any>

`Static` createAgent

`Optional` data: object

`Optional` params: Record<string, any>

`Static` createScheduler

`Optional` data: object

`Optional` params: Record<string, any>

`Static` creatorInviteContext

`Optional` params: Record<string, any>

`Static` credits

`Optional` params: Record<string, any>

`Static` deactivateMemory

`Optional` params: Record<string, any>

`Static` deleteAgent

`Optional` params: Record<string, any>

`Static` downloadAgentFile

`Static` executeAction

`Optional` data: object

`Optional` params: Record<string, any>

`Static` exportAgentFileToGoogleDrive

`Optional` data: object

`Optional` params: Record<string, any>

`Static` `Private` fetchWithAuth

`Static` heartbeatRun