Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

60.3 KB
Raw Blame

Reference

Internal

client.internal.listPermissions({ ...params }) -> TrueForge.ListPermissionsResponse

πŸ“ Description

Return granted actions for the requested resources.

πŸ”Œ Usage

await client.internal.listPermissions({
    resourceIds: ["resource_ids"],
    resourceType: "agent"
});

βš™οΈ Parameters

request: TrueForge.ListPermissionsRequest

requestOptions: InternalClient.RequestOptions

Agents

client.agents.list({ ...params }) -> core.Page<TrueForge.Agent, TrueForge.ListAgentsResponse>

πŸ“ Description

List configured agents for the tenant, ordered by name. Optional agent_name filters by substring.

πŸ”Œ Usage

const pageableResponse = await client.agents.list();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.agents.list();
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

request: TrueForge.ListAgentsRequest

requestOptions: AgentsClient.RequestOptions

client.agents.create({ ...params }) -> TrueForge.GetAgentResponse

πŸ“ Description

Creates an agent and allocates an immutable id. Fails if name is already taken. Name cannot be changed later.

πŸ”Œ Usage

await client.agents.create({
    description: "description",
    manifest: {
        model: {
            name: "name"
        }
    },
    name: "name"
});

βš™οΈ Parameters

request: TrueForge.CreateAgentRequest

requestOptions: AgentsClient.RequestOptions

client.agents.get(agent_id) -> TrueForge.GetAgentResponse

πŸ“ Description

Fetch a configured agent by immutable id.

πŸ”Œ Usage

await client.agents.get("agent_id");

βš™οΈ Parameters

agent_id: string β€” Immutable agent identifier.

requestOptions: AgentsClient.RequestOptions

client.agents.update(agent_id, { ...params }) -> TrueForge.GetAgentResponse

πŸ“ Description

Update an existing agent by immutable id.

πŸ”Œ Usage

await client.agents.update("agent_id", {
    manifest: {
        model: {
            name: "name"
        }
    }
});

βš™οΈ Parameters

agent_id: string β€” Immutable agent identifier.

request: TrueForge.UpdateAgentRequest

requestOptions: AgentsClient.RequestOptions

client.agents.delete(agent_id) -> TrueForge.DeleteAgentResponse

πŸ“ Description

Delete a configured agent by immutable id.

πŸ”Œ Usage

await client.agents.delete("agent_id");

βš™οΈ Parameters

agent_id: string β€” Immutable agent identifier.

requestOptions: AgentsClient.RequestOptions

Auth

client.auth.me() -> TrueForge.GetMeResponse

πŸ“ Description

Returns the authenticated caller identity (type, tenant_id, subject, roles) wrapped as { data }. type is oidc-connected when browser OIDC is enabled, otherwise default. When auth is enabled this requires a valid id_token cookie or Authorization: Bearer token (401 otherwise). When auth is disabled, returns the standalone default identity.

πŸ”Œ Usage

await client.auth.me();

βš™οΈ Parameters

requestOptions: AuthClient.RequestOptions

Server

client.server.getCapabilities() -> TrueForge.GetCapabilitiesResponse

πŸ“ Description

Report optional runtime capabilities available for this tenant.

πŸ”Œ Usage

await client.server.getCapabilities();

βš™οΈ Parameters

requestOptions: ServerClient.RequestOptions

MCP Servers

client.mcpServers.list() -> TrueForge.ListAvailableMcpServersResponse

πŸ“ Description

Configured MCP servers as a slim name/url list for the composer.

πŸ”Œ Usage

await client.mcpServers.list();

βš™οΈ Parameters

requestOptions: McpServersClient.RequestOptions

client.mcpServers.get(name) -> TrueForge.GetAvailableMcpServerResponse

πŸ“ Description

A single MCP server as the slim chat projection, with live per-user auth_status.

πŸ”Œ Usage

await client.mcpServers.get("name");

βš™οΈ Parameters

name: string β€” MCP server name.

requestOptions: McpServersClient.RequestOptions

client.mcpServers.authorize(name, { ...params }) -> TrueForge.McpAuthStatus

πŸ“ Description

Returns current auth status. When OAuth is required, includes an authorization URL. Optional return_to is the post-consent landing path.

πŸ”Œ Usage

await client.mcpServers.authorize("name");

βš™οΈ Parameters

name: string β€” MCP server name.

request: TrueForge.AuthorizeMcpServersRequest

requestOptions: McpServersClient.RequestOptions

client.mcpServers.deleteAuthorization(name) -> TrueForge.GetMcpServerResponse

πŸ“ Description

Disconnects OAuth for the MCP server when applicable and returns the updated server with auth_status. No-op when the server does not use stored OAuth tokens.

πŸ”Œ Usage

await client.mcpServers.deleteAuthorization("name");

βš™οΈ Parameters

name: string β€” MCP server name.

requestOptions: McpServersClient.RequestOptions

client.mcpServers.listTools(name) -> TrueForge.ListMcpServerToolsResponse

πŸ“ Description

All tools exposed by the given MCP server (non-paginated), as returned by the MCP tools/list call.

πŸ”Œ Usage

await client.mcpServers.listTools("name");

βš™οΈ Parameters

name: string β€” MCP server name.

requestOptions: McpServersClient.RequestOptions

Models

client.models.list() -> TrueForge.ListAvailableModelsResponse

πŸ“ Description

Configured models as a slim FQN list for the composer.

πŸ”Œ Usage

await client.models.list();

βš™οΈ Parameters

requestOptions: ModelsClient.RequestOptions

SandboxEnvironments

client.sandboxEnvironments.list({ ...params }) -> core.Page<TrueForge.SandboxEnvironment, TrueForge.ListSandboxEnvironmentsResponse>

πŸ“ Description

List available sandbox environments

πŸ”Œ Usage

const pageableResponse = await client.sandboxEnvironments.list();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.sandboxEnvironments.list();
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

request: TrueForge.ListSandboxEnvironmentsRequest

requestOptions: SandboxEnvironmentsClient.RequestOptions

client.sandboxEnvironments.create({ ...params }) -> TrueForge.GetSandboxEnvironmentResponse

πŸ“ Description

Creates by manifest.name. Fails if the name is already taken. Requires a configured sandbox provider.

πŸ”Œ Usage

await client.sandboxEnvironments.create({
    manifest: {
        name: "name"
    }
});

βš™οΈ Parameters

request: TrueForge.CreateSandboxEnvironmentRequest

requestOptions: SandboxEnvironmentsClient.RequestOptions

client.sandboxEnvironments.createOrUpdate({ ...params }) -> TrueForge.GetSandboxEnvironmentResponse

πŸ“ Description

Create a new sandbox environment or update an existing one.

πŸ”Œ Usage

await client.sandboxEnvironments.createOrUpdate({
    manifest: {
        name: "name"
    }
});

βš™οΈ Parameters

request: TrueForge.UpdateSandboxEnvironmentRequest

requestOptions: SandboxEnvironmentsClient.RequestOptions

client.sandboxEnvironments.get(name) -> TrueForge.GetSandboxEnvironmentResponse

πŸ”Œ Usage

await client.sandboxEnvironments.get("name");

βš™οΈ Parameters

name: string β€” Sandbox environment name.

requestOptions: SandboxEnvironmentsClient.RequestOptions

client.sandboxEnvironments.delete(name) -> TrueForge.DeleteSandboxEnvironmentResponse

πŸ“ Description

Delete a sandbox environment, fails if any agent still references it.

πŸ”Œ Usage

await client.sandboxEnvironments.delete("name");

βš™οΈ Parameters

name: string β€” Sandbox environment name.

requestOptions: SandboxEnvironmentsClient.RequestOptions

Schedules

client.schedules.list({ ...params }) -> core.Page<TrueForge.Schedule, TrueForge.ListSchedulesResponse>

πŸ“ Description

List schedules for the tenant, newest first.

πŸ”Œ Usage

const pageableResponse = await client.schedules.list();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.schedules.list();
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

request: TrueForge.ListSchedulesRequest

requestOptions: SchedulesClient.RequestOptions

client.schedules.create({ ...params }) -> TrueForge.GetScheduleResponse

πŸ“ Description

Create a schedule for an existing agent (by name) and add its first pending run when active.

πŸ”Œ Usage

await client.schedules.create({
    agentName: "agent_name",
    manifest: {
        cron: "cron",
        task: "task"
    },
    name: "name"
});

βš™οΈ Parameters

request: TrueForge.CreateScheduleRequest

requestOptions: SchedulesClient.RequestOptions

client.schedules.createRun({ ...params }) -> TrueForge.CreateScheduleRunResponse

πŸ“ Description

Start a schedule run immediately using the schedule task. Does not replace or advance the cron pending run.

πŸ”Œ Usage

await client.schedules.createRun({
    scheduleId: "schedule_id"
});

βš™οΈ Parameters

request: TrueForge.CreateScheduleRunRequest

requestOptions: SchedulesClient.RequestOptions

client.schedules.get(schedule_id) -> TrueForge.GetScheduleResponse

πŸ“ Description

Get a schedule by id.

πŸ”Œ Usage

await client.schedules.get("schedule_id");

βš™οΈ Parameters

schedule_id: string β€” Immutable schedule identifier.

requestOptions: SchedulesClient.RequestOptions

client.schedules.update(schedule_id, { ...params }) -> TrueForge.GetScheduleResponse

πŸ“ Description

Replace name and manifest; replaces or drops the pending run when status/cron/timezone change.

πŸ”Œ Usage

await client.schedules.update("schedule_id", {
    manifest: {
        cron: "cron",
        task: "task"
    },
    name: "name"
});

βš™οΈ Parameters

schedule_id: string β€” Immutable schedule identifier.

request: TrueForge.UpdateScheduleRequest

requestOptions: SchedulesClient.RequestOptions

client.schedules.delete(schedule_id) -> TrueForge.DeleteScheduleResponse

πŸ“ Description

Delete a schedule and its runs. Idempotent.

πŸ”Œ Usage

await client.schedules.delete("schedule_id");

βš™οΈ Parameters

schedule_id: string β€” Immutable schedule identifier.

requestOptions: SchedulesClient.RequestOptions

client.schedules.listRuns(schedule_id, { ...params }) -> core.Page<TrueForge.ScheduleRun, TrueForge.ListScheduleRunsResponse>

πŸ“ Description

List runs of a schedule, newest scheduled_for first. Available to its creator or a manager of its agent.

πŸ”Œ Usage

const pageableResponse = await client.schedules.listRuns("schedule_id");
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.schedules.listRuns("schedule_id");
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

schedule_id: string β€” Immutable schedule identifier.

request: TrueForge.ListRunsSchedulesRequest

requestOptions: SchedulesClient.RequestOptions

Sessions

client.sessions.list({ ...params }) -> core.Page<TrueForge.Session, TrueForge.ListSessionsResponse>

πŸ“ Description

List the sessions (newest first by default).

πŸ”Œ Usage

const pageableResponse = await client.sessions.list();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.sessions.list();
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

request: TrueForge.ListSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.create({ ...params }) -> TrueForge.GetSessionResponse

πŸ“ Description

Create a session with agent as either { name } (named registry binding) or { spec: AgentSpec } (inline). Named sessions snapshot the agent name at create and resolve the live agent on each turn. Responses use { type: "reference", name, id } or { type: "inline", spec }.

πŸ”Œ Usage

await client.sessions.create({
    agent: {
        name: "name"
    }
});

βš™οΈ Parameters

request: TrueForge.CreateSessionRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.get(session_id) -> TrueForge.GetSessionResponse

πŸ“ Description

Fetch a session by ID. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.

πŸ”Œ Usage

await client.sessions.get("session_id");

βš™οΈ Parameters

session_id: string β€” Session identifier.

requestOptions: SessionsClient.RequestOptions

client.sessions.delete(session_id) -> void

πŸ“ Description

Delete a session and all related turns, events, and internal state. Only the session creator may delete it. Idempotent if already gone.

πŸ”Œ Usage

await client.sessions.delete("session_id");

βš™οΈ Parameters

session_id: string β€” Session identifier.

requestOptions: SessionsClient.RequestOptions

client.sessions.update(session_id, { ...params }) -> TrueForge.GetSessionResponse

πŸ“ Description

Update a session: optional title, metadata, shared, and (inline sessions only) agent as { spec: AgentSpec }. Named sessions reject agent updates. An empty body is a valid no-op that refreshes updated_at. Only the session creator may update it.

πŸ”Œ Usage

await client.sessions.update("session_id");

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.UpdateSessionRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.cancel(session_id, { ...params }) -> TrueForge.CancelSessionResponse

πŸ“ Description

Cancel the running last turn for a session. Only the session creator may cancel.

πŸ”Œ Usage

await client.sessions.cancel("session_id");

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.CancelSessionRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.listEvents(session_id, { ...params }) -> core.Page<TrueForge.SessionEventItem, TrueForge.ListSessionEventsResponse>

πŸ“ Description

List session events as { turn_id, event } across the active turn branch (newest first), including persisted events from a running tip. Each turn contributes turn.created, content events (model.message, tool.call, …), and turn.done when terminal; streaming deltas are not included. Use page_token to paginate backward toward older events while retaining the original branch anchor. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.

πŸ”Œ Usage

const pageableResponse = await client.sessions.listEvents("session_id");
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.sessions.listEvents("session_id");
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.ListEventsSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.listTurns(session_id, { ...params }) -> core.Page<TrueForge.Turn, TrueForge.ListTurnsResponse>

πŸ“ Description

List turns for a session (newest first by default), token-paginated. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.

πŸ”Œ Usage

const pageableResponse = await client.sessions.listTurns("session_id");
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.sessions.listTurns("session_id");
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.ListTurnsSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.createTurnStream(session_id, { ...params }) -> core.Stream<TrueForge.TurnStreamingEvent>

πŸ“ Description

Create a turn within a session and execute it. Only the session creator may create turns. When stream is true (default), respond with a Server-Sent Events stream of turn events. When stream is false, return the turn immediately with state.status: "running" while execution continues in the background; use get turn or subscribe to observe completion. Use previous_turn_id to chain to the session's last turn (defaults to auto); use none for a new root.

πŸ”Œ Usage

const response = await client.sessions.createTurnStream("session_id", {});
for await (const item of response) {
    console.log(item);
}

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.CreateTurnSessionsStreamRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.createTurn(session_id, { ...params }) -> TrueForge.GetTurnResponse

πŸ“ Description

Create a turn within a session and execute it. Only the session creator may create turns. When stream is true (default), respond with a Server-Sent Events stream of turn events. When stream is false, return the turn immediately with state.status: "running" while execution continues in the background; use get turn or subscribe to observe completion. Use previous_turn_id to chain to the session's last turn (defaults to auto); use none for a new root.

πŸ”Œ Usage

await client.sessions.createTurn("session_id", {});

βš™οΈ Parameters

session_id: string β€” Session identifier.

request: TrueForge.CreateTurnSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.getTurn(session_id, turn_id) -> TrueForge.GetTurnResponse

πŸ“ Description

Fetch a single turn by ID. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.

πŸ”Œ Usage

await client.sessions.getTurn("session_id", "turn_id");

βš™οΈ Parameters

session_id: string β€” Session identifier.

turn_id: string β€” Turn identifier.

requestOptions: SessionsClient.RequestOptions

client.sessions.downloadSandboxFile(session_id, turn_id, { ...params }) -> core.BinaryResponse

πŸ“ Description

Download a file from the sandbox this turn ran in. Paths come from the assistant's sandbox_artifacts block. Only the session creator may download.

πŸ”Œ Usage

await client.sessions.downloadSandboxFile("session_id", "turn_id", {
    path: "x"
});

βš™οΈ Parameters

session_id: string β€” Session identifier.

turn_id: string β€” Turn identifier.

request: TrueForge.DownloadSandboxFileSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.listTurnEvents(session_id, turn_id, { ...params }) -> core.Page<TrueForge.SessionEvent, TrueForge.ListTurnEventsResponse>

πŸ“ Description

Paginated persisted events for a turn (insertion order by default). Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.

πŸ”Œ Usage

const pageableResponse = await client.sessions.listTurnEvents("session_id", "turn_id");
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.sessions.listTurnEvents("session_id", "turn_id");
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

βš™οΈ Parameters

session_id: string β€” Session identifier.

turn_id: string β€” Turn identifier.

request: TrueForge.ListTurnEventsSessionsRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.createTurnEvent(session_id, turn_id, { ...params }) -> TrueForge.CreateTurnEventResponse

πŸ“ Description

Create events for a turn. Only the session creator may create them.

πŸ”Œ Usage

await client.sessions.createTurnEvent("session_id", "turn_id", {
    events: [{
            type: "user.mcp_auth_continue"
        }]
});

βš™οΈ Parameters

session_id: string β€” Session identifier.

turn_id: string β€” Turn identifier.

request: TrueForge.CreateTurnEventRequest

requestOptions: SessionsClient.RequestOptions

client.sessions.subscribeToTurn(session_id, turn_id, { ...params }) -> core.Stream<TrueForge.TurnStreamingEvent>

πŸ“ Description

Subscribe to the live SSE stream for a turn. Only the session creator may subscribe. Pass after_sequence_number to resume after a disconnect (exclusive β€” events after this sequence number are replayed).

πŸ”Œ Usage

const response = await client.sessions.subscribeToTurn("session_id", "turn_id");
for await (const item of response) {
    console.log(item);
}

βš™οΈ Parameters

session_id: string β€” Session identifier.

turn_id: string β€” Turn identifier.

request: TrueForge.SubscribeToTurnSessionsRequest

requestOptions: SessionsClient.RequestOptions

Skills

client.skills.list() -> TrueForge.ListAvailableSkillsResponse

πŸ“ Description

Configured skills as a slim name/description list for the composer.

πŸ”Œ Usage

await client.skills.list();

βš™οΈ Parameters

requestOptions: SkillsClient.RequestOptions

client.skills.listVersions({ ...params }) -> TrueForge.ListSkillVersionsResponse

πŸ“ Description

Versions for one skill.

πŸ”Œ Usage

await client.skills.listVersions({
    name: "name"
});

βš™οΈ Parameters

request: TrueForge.ListVersionsSkillsRequest

requestOptions: SkillsClient.RequestOptions

Catalogs McpServers

client.catalogs.mcpServers.list() -> TrueForge.GetMcpServerCatalogResponse

πŸ“ Description

Shipped MCP server presets (discovery-only). Copy into PUT /settings/mcp-servers to configure.

πŸ”Œ Usage

await client.catalogs.mcpServers.list();

βš™οΈ Parameters

requestOptions: McpServersClient.RequestOptions

Catalogs ModelProviders

client.catalogs.modelProviders.list() -> TrueForge.GetModelProviderCatalogResponse

πŸ“ Description

Shipped model-provider presets (discovery-only). Copy into PUT /settings/model-providers to configure. Includes a custom sentinel with supported_reasoning_efforts.

πŸ”Œ Usage

await client.catalogs.modelProviders.list();

βš™οΈ Parameters

requestOptions: ModelProvidersClient.RequestOptions

Catalogs SandboxProviders

client.catalogs.sandboxProviders.list() -> TrueForge.GetSandboxProviderCatalogResponse

πŸ“ Description

Shipped sandbox-provider presets (discovery-only). Copy into PUT /settings/sandbox-providers to configure.

πŸ”Œ Usage

await client.catalogs.sandboxProviders.list();

βš™οΈ Parameters

requestOptions: SandboxProvidersClient.RequestOptions

Catalogs Skills

client.catalogs.skills.list() -> TrueForge.GetSkillCatalogResponse

πŸ“ Description

Shipped skill presets (discovery-only). Copy into PUT /settings/skills to configure.

πŸ”Œ Usage

await client.catalogs.skills.list();

βš™οΈ Parameters

requestOptions: SkillsClient.RequestOptions

Catalogs WebSearchProviders

client.catalogs.webSearchProviders.list() -> TrueForge.GetWebSearchProviderCatalogResponse

πŸ“ Description

Shipped web-search provider presets.

πŸ”Œ Usage

await client.catalogs.webSearchProviders.list();

βš™οΈ Parameters

requestOptions: WebSearchProvidersClient.RequestOptions

Internal Metrics

client.internal.metrics.listCharts() -> TrueForge.GetSessionMetricsChartResponse

πŸ“ Description

List available session metric charts.

πŸ”Œ Usage

await client.internal.metrics.listCharts();

βš™οΈ Parameters

requestOptions: MetricsClient.RequestOptions

client.internal.metrics.getChartData({ ...params }) -> TrueForge.GetSessionMetricsChartDataResponse

πŸ“ Description

Return one chart for the caller's sessions on a named agent over an inclusive creation-time window. Uses hourly buckets for windows up to 24 hours and daily UTC buckets otherwise.

πŸ”Œ Usage

await client.internal.metrics.getChartData({
    agentId: "agent_id",
    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
    endTimestamp: new Date("2024-01-15T09:30:00.000Z"),
    chartName: "sessions_over_time"
});

βš™οΈ Parameters

request: TrueForge.internal.GetChartDataMetricsRequest

requestOptions: MetricsClient.RequestOptions

client.internal.metrics.getMeters({ ...params }) -> TrueForge.GetSessionMetricsMeterResponse

πŸ“ Description

Aggregate the caller's session meters for a named agent over an inclusive creation-time window.

πŸ”Œ Usage

await client.internal.metrics.getMeters({
    agentId: "agent_id",
    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
    endTimestamp: new Date("2024-01-15T09:30:00.000Z")
});

βš™οΈ Parameters

request: TrueForge.internal.GetMetersMetricsRequest

requestOptions: MetricsClient.RequestOptions

Internal SandboxEnvironments

client.internal.sandboxEnvironments.listPending() -> TrueForge.ListPendingSandboxEnvironmentVersionsResponse

πŸ“ Description

Returns pending environment versions for the build controller.

πŸ”Œ Usage

await client.internal.sandboxEnvironments.listPending();

βš™οΈ Parameters

requestOptions: SandboxEnvironmentsClient.RequestOptions

client.internal.sandboxEnvironments.progress({ ...params }) -> void

πŸ“ Description

Registers or polls the snapshot build and updates version status.

πŸ”Œ Usage

await client.internal.sandboxEnvironments.progress({
    environmentVersionId: "environment_version_id"
});

βš™οΈ Parameters

request: TrueForge.internal.ProgressSandboxEnvironmentVersionRequest

requestOptions: SandboxEnvironmentsClient.RequestOptions

Internal Schedules

client.internal.schedules.executeRun({ ...params }) -> void

πŸ“ Description

Execute a persisted schedule run using its saved schedule and agent.

πŸ”Œ Usage

await client.internal.schedules.executeRun({
    scheduleRunId: "schedule_run_id"
});

βš™οΈ Parameters

request: TrueForge.internal.ExecuteScheduleRunRequest

requestOptions: SchedulesClient.RequestOptions

Internal Sessions

client.internal.sessions.getOrCreateByExternalId({ ...params }) -> TrueForge.GetSessionResponse

πŸ“ Description

Idempotent get-or-create: returns the existing session for this external_id, or creates one

πŸ”Œ Usage

await client.internal.sessions.getOrCreateByExternalId({
    agent: {
        name: "name"
    },
    externalId: "external_id"
});

βš™οΈ Parameters

request: TrueForge.internal.GetOrCreateSessionByExternalIdRequest

requestOptions: SessionsClient.RequestOptions

Internal Agents

client.internal.agents.getCodeSnippets(agent_id, { ...params }) -> TrueForge.GetAgentCodeSnippetsResponse

πŸ“ Description

TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.

πŸ”Œ Usage

await client.internal.agents.getCodeSnippets("agent_id");

βš™οΈ Parameters

agent_id: string β€” Immutable agent identifier.

request: TrueForge.internal.GetCodeSnippetsAgentsRequest

requestOptions: AgentsClient.RequestOptions

Settings McpServers

client.settings.mcpServers.list() -> TrueForge.ListMcpServersResponse

πŸ“ Description

Configured MCP servers with auth_status. Header secrets are redacted.

πŸ”Œ Usage

await client.settings.mcpServers.list();

βš™οΈ Parameters

requestOptions: McpServersClient.RequestOptions

client.settings.mcpServers.create({ ...params }) -> TrueForge.GetMcpServerResponse

πŸ“ Description

Creates an MCP server by name. Fails if name is already taken. Runs DCR registration when auth.type is dcr. Header secrets: real value required; redacted with no stored value returns 400.

πŸ”Œ Usage

await client.settings.mcpServers.create({
    manifest: {
        description: "description",
        name: "name",
        type: "remote",
        url: "url"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.CreateMcpServerRequest

requestOptions: McpServersClient.RequestOptions

client.settings.mcpServers.createOrUpdate({ ...params }) -> TrueForge.GetMcpServerResponse

πŸ“ Description

Create or replace by name. Header secrets: real value sets/rotates; redacted keeps existing (400 if none).

πŸ”Œ Usage

await client.settings.mcpServers.createOrUpdate({
    manifest: {
        description: "description",
        name: "name",
        type: "remote",
        url: "url"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.UpdateMcpServerRequest

requestOptions: McpServersClient.RequestOptions

client.settings.mcpServers.get(name) -> TrueForge.GetMcpServerResponse

πŸ“ Description

A single MCP server by name, with nested live auth_status (settings / admin projection). Header auth values are redacted.

πŸ”Œ Usage

await client.settings.mcpServers.get("name");

βš™οΈ Parameters

name: string β€” MCP server name.

requestOptions: McpServersClient.RequestOptions

client.settings.mcpServers.delete(name) -> TrueForge.DeleteMcpServerResponse

πŸ“ Description

Deletes an MCP server by name, along with every stored OAuth token for it. Rejected while any agent still lists the server.

πŸ”Œ Usage

await client.settings.mcpServers.delete("name");

βš™οΈ Parameters

name: string β€” MCP server name.

requestOptions: McpServersClient.RequestOptions

Settings ModelProviders

client.settings.modelProviders.list() -> TrueForge.ListModelProvidersResponse

πŸ“ Description

All configured providers with nested manifests.

πŸ”Œ Usage

await client.settings.modelProviders.list();

βš™οΈ Parameters

requestOptions: ModelProvidersClient.RequestOptions

client.settings.modelProviders.create({ ...params }) -> TrueForge.GetModelProviderResponse

πŸ“ Description

Creates a provider (models included). Fails if name is already taken. Well-known types use type as name (one each); custom is named by the caller. auth.api_key: real value required; redacted with no stored secret returns 400.

πŸ”Œ Usage

await client.settings.modelProviders.create({
    manifest: {
        auth: {
            apiKey: "api_key"
        },
        models: [{
                modelId: "model_id",
                name: "name",
                properties: {}
            }],
        type: "alibaba"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.CreateModelProviderRequest

requestOptions: ModelProvidersClient.RequestOptions

client.settings.modelProviders.createOrUpdate({ ...params }) -> TrueForge.GetModelProviderResponse

πŸ“ Description

Create or replace a provider (models included). Well-known types use type as name (one each); custom is named by the caller. auth.api_key: real value sets/rotates; redacted keeps existing (400 if none).

πŸ”Œ Usage

await client.settings.modelProviders.createOrUpdate({
    manifest: {
        auth: {
            apiKey: "api_key"
        },
        models: [{
                modelId: "model_id",
                name: "name",
                properties: {}
            }],
        type: "alibaba"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.UpdateModelProviderRequest

requestOptions: ModelProvidersClient.RequestOptions

client.settings.modelProviders.delete(name) -> TrueForge.DeleteModelProviderResponse

πŸ“ Description

Deletes a provider and every model it declares. Rejected while any agent still uses one of them.

πŸ”Œ Usage

await client.settings.modelProviders.delete("name");

βš™οΈ Parameters

name: string β€” Model provider name.

requestOptions: ModelProvidersClient.RequestOptions

Settings SandboxProviders

client.settings.sandboxProviders.get() -> TrueForge.GetSandboxProviderResponse

πŸ“ Description

The single configured sandbox provider for this tenant. auth.api_key is redacted.

πŸ”Œ Usage

await client.settings.sandboxProviders.get();

βš™οΈ Parameters

requestOptions: SandboxProvidersClient.RequestOptions

client.settings.sandboxProviders.createOrUpdate({ ...params }) -> TrueForge.GetSandboxProviderResponse

πŸ“ Description

Upserts the single sandbox provider for this tenant: creates it or replaces its entire configuration. auth.api_key: real value sets/rotates; redacted keeps existing (400 if none).

πŸ”Œ Usage

await client.settings.sandboxProviders.createOrUpdate({
    manifest: {
        auth: {
            apiKey: "api_key"
        },
        autoArchiveIntervalInMinutes: 1,
        autoDeleteIntervalInMinutes: 1,
        autoStopIntervalInMinutes: 1,
        execTimeoutMs: 1,
        type: "daytona"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.UpdateSandboxProviderRequest

requestOptions: SandboxProvidersClient.RequestOptions

Settings Skills

client.settings.skills.list() -> TrueForge.ListSkillsResponse

πŸ“ Description

All configured skills with nested manifests (settings / admin projection).

πŸ”Œ Usage

await client.settings.skills.list();

βš™οΈ Parameters

requestOptions: SkillsClient.RequestOptions

client.settings.skills.create({ ...params }) -> TrueForge.GetSkillResponse

πŸ“ Description

Creates a skill keyed by name. Fails if name is already taken.

πŸ”Œ Usage

await client.settings.skills.create({
    manifest: {
        description: "description",
        name: "name",
        ref: "ref",
        type: "git",
        url: "url"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.CreateSkillRequest

requestOptions: SkillsClient.RequestOptions

client.settings.skills.createOrUpdate({ ...params }) -> TrueForge.GetSkillResponse

πŸ“ Description

Full upsert keyed by name: creates the skill or replaces its entire manifest.

πŸ”Œ Usage

await client.settings.skills.createOrUpdate({
    manifest: {
        description: "description",
        name: "name",
        ref: "ref",
        type: "git",
        url: "url"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.UpdateSkillRequest

requestOptions: SkillsClient.RequestOptions

client.settings.skills.delete(name) -> TrueForge.DeleteSkillResponse

πŸ“ Description

Deletes a skill by name. Rejected while any agent still lists the skill.

πŸ”Œ Usage

await client.settings.skills.delete("name");

βš™οΈ Parameters

name: string β€” Skill name.

requestOptions: SkillsClient.RequestOptions

Settings WebSearchProviders

client.settings.webSearchProviders.get() -> TrueForge.GetWebSearchProviderResponse

πŸ“ Description

The configured provider for this tenant. auth.api_key is redacted when present.

πŸ”Œ Usage

await client.settings.webSearchProviders.get();

βš™οΈ Parameters

requestOptions: WebSearchProvidersClient.RequestOptions

client.settings.webSearchProviders.createOrUpdate({ ...params }) -> TrueForge.GetWebSearchProviderResponse

πŸ“ Description

Upserts the single web search provider for this tenant. auth.api_key: real value sets/rotates; redacted keeps existing (400 if none).

πŸ”Œ Usage

await client.settings.webSearchProviders.createOrUpdate({
    manifest: {
        auth: {
            apiKey: "api_key"
        },
        type: "parallel"
    }
});

βš™οΈ Parameters

request: TrueForge.settings.UpdateWebSearchProviderRequest

requestOptions: WebSearchProvidersClient.RequestOptions