Section ID:
DOC-API-MODEL-schema-ohmse4h323#overview
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.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ohmse4h323#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ohmse4h323#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ohmse4h323#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-profileidSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-profileidprofileId | string | Optional | Identifier of the agent profile associated with the operation or generation. |
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-nameSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-namename | string | Optional | Display name used when presenting an agent profile in the library. |
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-descriptionSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-whentouseSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-whentousewhenToUse | string | Optional | Instructions describing when this agent profile should be selected. |
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-keywordsSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-keywordskeywords | Array of string | Optional | Keywords associated with discovery or selection of the agent profile. |
Section ID: DOC-API-MODEL-schema-ohmse4h323#field-enabledSection ID: DOC-API-MODEL-schema-ohmse4h323#response-field-enabledenabled | boolean | Optional | Whether this configuration is enabled. |
Where used
Section ID: DOC-API-MODEL-schema-ohmse4h323#where-used
| Reference | Relationship |
|---|---|
| Get the profile library | POST /api/v1/agent-profiles/library |
Models containing this value
| Model | Relationship |
|---|---|
| AgentProfileLibrary | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ohmse4h323