AgentProfileMetadata
Profile identity and selection hints for a picker or router. This projection excludes the system prompt, generation settings, tools and MCP configuration; retrieve AgentProfile to inspect the runtime configuration. These hints do not establish that routing is active.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
profileId | string | Optional | Identifier of the agent profile associated with the operation or generation. |
name | string | Optional | Display name used when presenting an agent profile in the library. |
description | string | Optional | Human-readable description of the resource. |
whenToUse | string | Optional | Instructions describing when this agent profile should be selected. |
keywords | Array of string | Optional | Keywords associated with discovery or selection of the agent profile. |
enabled | boolean | Optional | Whether this configuration is enabled. |
Where used
| Reference | Relationship |
|---|---|
| Get the profile library | POST /api/v1/agent-profiles/library |
| AgentProfileLibrary | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-agent-profile-metadata.