Skip to content

Interface: AgentProfileSummary ​

Defined in: packages/sdk/src/agents-service.ts:343

Beta

One Agent Profile as an extension may read it through AgentProfilesService.list — a named recipe for starting a coding agent in a terminal, defined by the user on Settings → Agents → Profiles. Deliberately a summary, never the host's own profile record: the command line, its config directory, and every other launch detail stay host-owned (RFC 0033).

Properties ​

id ​

ts
readonly id: string;

Defined in: packages/sdk/src/agents-service.ts:345

Beta

Stable id — pass it to AgentProfilesService.launch.


label ​

ts
readonly label: string;

Defined in: packages/sdk/src/agents-service.ts:348

Beta

The user's own name for this profile, e.g. "Claude (work)". Show this; never show or parse the id.


isDefault ​

ts
readonly isDefault: boolean;

Defined in: packages/sdk/src/agents-service.ts:352

Beta

True for the single profile marked default, which is what launch() starts when no profileId is given. False for every profile when the user has not chosen one.


acceptsPrompt ​

ts
readonly acceptsPrompt: boolean;

Defined in: packages/sdk/src/agents-service.ts:359

Beta

Whether this profile's agent can be given an opening prompt. A static fact about the agent, not about any particular launch — so a picker can grey out or annotate a profile up front instead of discovering "agent-takes-none" after the user has already typed one.


interface ​

ts
readonly interface: AgentSessionKind;

Defined in: packages/sdk/src/agents-service.ts:375

Beta

Which interface this profile starts the agent through — the profile's launch arm, expressed in the same AgentSessionKind vocabulary AgentInfo.kind uses (RFC 0038):

The two are driven through different services, so a picker must filter on this rather than offer every profile to both: launch()ing a Chat profile and connect()ing a Terminal profile both fail, and the user should never be offered a profile that cannot work in the surface they are looking at.


agentId? ​

ts
readonly optional agentId?: string;

Defined in: packages/sdk/src/agents-service.ts:385

Beta

The catalog agent this profile resolves to, if any — the same id AgentsService.catalog keys on, and the same resolution AgentSessionHandle.agentId reports once a Chat session is live (the profile's explicit assertion, or an auto-detect match from its command line). Look up CatalogAgentSummary.icon with it to show a profile's brand mark in a picker before connecting — undefined when the profile resolves to no known agent.