Skip to main content

Get a fragment set by version

POST 
/api/v1/prompt-fragments/get-set

Returns the fragments in a specified project-wide fragment-set version, ordered by fragment ID. Fragment writes advance the set version. A set version reconstructs that stored set, not a complete rendered turn. Current profile and fragment reads are independent and rendering can use the latest set; capture the set actually used alongside variables and effective configuration.

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: Reuse and update shared assistant instructions · Profile selection and prompt versions

Request​

Responses​

Fragments at that set version

Schema-valid request illustration; replace example identifiers and confirm operation prerequisites.​

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

Request example

{
  "setVersion": 1
}

Guide request for Recover the text used before a change. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-MA-profiles-prompts-api-getPromptFragmentSet#example-cookbook-managed-agents-profiles-prompts-prompt-fragments-05-request

Request example

{
  "setVersion": 7
}

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

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

Response example

{
  "setVersion": 1,
  "fragments": [
    {
      "fragmentId": "example_123",
      "name": "example",
      "content": "Example text"
    }
  ]
}

Illustrative response for Recover the text used before a change. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-MA-profiles-prompts-api-getPromptFragmentSet#example-cookbook-managed-agents-profiles-prompts-prompt-fragments-json-04-response

Response example

{
  "setVersion": 7,
  "fragments": [
    {
      "fragmentId": "safety",
      "name": "Safety rules",
      "content": "Never give medical advice. Refer the user to a clinician when asked."
    }
  ]
}

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

SectionStable reference
Get a fragment set by versionDOC-MA-profiles-prompts-api-getPromptFragmentSet#overview
RequestDOC-MA-profiles-prompts-api-getPromptFragmentSet#request
ResponsesDOC-MA-profiles-prompts-api-getPromptFragmentSet#responses