Agent Profile APIs
Manage agent profiles, their versions and reusable prompt fragments. Select profiles on the conversation API using activeProfileId at creation or setActiveProfileId when sending.
Use an authorized backend sk_… key in X-API-Key; these configuration operations do not need an end-user identity. A console JWT belongs to the separate console surface. See Authentication.
Tenant context comes from the authenticated request. Client-supplied X-Tenant-Id, X-User-Id or X-Project-Id do not grant authority. The current public integration uses the default project. Do not rely on project headers for separate project, test/live or customer isolation on this API.
A profile version pins that profile record. Current fragment resolution can use the latest fragment set; a profile version alone is not a complete record of the prompt or configuration used by a turn.
Related guide: Create and version agent profiles
JSON conventions
Requests accept snake_case or camelCase field names; responses use camelCase. Ordinary default-valued scalars and empty repeated fields can be omitted. Explicitly present optional scalars, map values and well-known JSON types follow their own presence rules: an explicit false, 0 or empty value is not universally equivalent to absence. Decode each field according to its schema. 64-bit integers use JSON strings; preserve their precision. Unknown request fields are generally discarded before validation, so a typo can silently change behavior. This is not a guarantee that arbitrary fields or future client contracts are supported. See API conventions.
Authentication
- API Key: apiKeyAuth
Authorized tenant backend secret key (sk_…). No end-user identity is needed for these configuration operations. Keep the key out of client apps; authorization and provisioning still apply.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
📄️ Overview
Manage agent profiles, their versions and reusable prompt fragments. Select profiles on the conversation API using `activeProfileId` at creation or `setActiveProfileId` when sending.
📄️ Profile selection and prompt versions
overview}
🗃️ Endpoints
15 items
🗃️ Models
10 items
Document ID: DOC-MA-profiles-prompts-api-overview. Section identities and revisions.
| Section | Stable reference |
|---|---|
| Overview | DOC-MA-profiles-prompts-api-overview#overview |
| JSON conventions | DOC-MA-profiles-prompts-api-overview#json-conventions |
| Authentication | DOC-MA-profiles-prompts-api-overview#authentication |
| Scoping | DOC-MA-profiles-prompts-api-overview#scoping |