The open-source agent harness - the runtime layer that turns an LLM into a working agent.
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_namefilters 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
nameis 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 }.typeisoidc-connectedwhen browser OIDC is enabled, otherwisedefault. When auth is enabled this requires a validid_tokencookie orAuthorization: Bearertoken (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/listcall.
-
π 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_forfirst. 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
agentas 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)agentas{ spec: AgentSpec }. Named sessions reject agent updates. An empty body is a valid no-op that refreshesupdated_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. Usepage_tokento 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
streamis true (default), respond with a Server-Sent Events stream of turn events. Whenstreamis false, return the turn immediately withstate.status: "running"while execution continues in the background; use get turn or subscribe to observe completion. Useprevious_turn_idto chain to the session's last turn (defaults toauto); usenonefor 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
streamis true (default), respond with a Server-Sent Events stream of turn events. Whenstreamis false, return the turn immediately withstate.status: "running"while execution continues in the background; use get turn or subscribe to observe completion. Useprevious_turn_idto chain to the session's last turn (defaults toauto); usenonefor 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_artifactsblock. 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_numberto 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
customsentinel withsupported_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 ifnameis already taken. Runs DCR registration whenauth.typeisdcr. 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
nameis already taken. Well-known types usetypeasname(one each);customis 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
typeasname(one each);customis 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_keyis 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 ifnameis 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_keyis 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
-
-