Skip to main content

Delete an agent profile

POST 

/api/v1/agent-profiles/delete

Deletes the profile from the current library without checking whether conversations still reference it. Resolve dependent conversations before deletion.

  • Direct sends on conversations still naming it in activeProfileId fail with ACTIVE_PROFILE_NOT_FOUND. Select an enabled replacement or restore the profile. A disabled replacement fails with ACTIVE_PROFILE_DISABLED. Queued messages can fall back to defaults and log the problem; see unusable profiles.
  • Historical version records remain. Their retention does not prove that every dependent turn remains reproducible.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build a reusable assistant profile

Request​

Responses​

Profile deleted

Use the profileId of an existing profile in your project.​

Section ID: DOC-MA-profiles-prompts-api-deleteAgentProfile#example-agent-profiles-deleteAgentProfile-request

Request example

{
"profileId": "support-assistant"
}

Guide request for Retire an assistant without stranding its conversations. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-MA-profiles-prompts-api-deleteAgentProfile#example-cookbook-managed-agents-profiles-prompts-index-07-request

Request example

{
"profileId": "nutrition_coach"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-MA-profiles-prompts-api-deleteAgentProfile#example-agent-profiles-deleteAgentProfile-response

Response example

{}

Document ID: DOC-MA-profiles-prompts-api-deleteAgentProfile. Section identities and revisions.

SectionStable reference
Delete an agent profileDOC-MA-profiles-prompts-api-deleteAgentProfile#overview
RequestDOC-MA-profiles-prompts-api-deleteAgentProfile#request
ResponsesDOC-MA-profiles-prompts-api-deleteAgentProfile#responses