Get an agent profile

POST 
/api/v1/agent-profiles/get

Returns a full profile record at the selected immutable version. A profile or version that never existed returns NOT_FOUND.

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

200

Profile returned

Use the profileId of an existing profile in your project.

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

Request example

{
  "profileId": "support-assistant"
}

Guide request for Step 2: Confirm what you saved. Replace example resource identifiers with your own authorized values.

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

Request example

{
  "profileId": "nutrition_coach"
}

Guide request for Step 2: Confirm what you saved. Replace example resource identifiers with your own authorized values.

Section ID: DOC-MA-profiles-prompts-api-getAgentProfile#example-cookbook-managed-agents-profiles-prompts-index-json-02-request

Request example

{
  "profileId": "nutrition_coach",
  "version": 3
}

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

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

Response example

{
  "profile": {
    "profileId": "example_123",
    "name": "example",
    "description": "example",
    "whenToUse": "example",
    "keywords": [
      "example_123"
    ],
    "enabled": true,
    "generationConfig": {
      "model": "example",
      "models": [
        "example"
      ],
      "systemPrompt": "Example text",
      "transforms": [
        "example"
      ],
      "temperature": 1,
      "topP": 1,
      "maxOutputTokens": 1,
      "frequencyPenalty": 1,
      "presencePenalty": 1,
      "stopSequences": [
        "example"
      ],
      "seed": "1",
      "allowParallelToolCalls": true,
      "topK": 1,
      "repetitionPenalty": 1,
      "topLogprobs": 1,
      "minP": 1,
      "topA": 1,
      "user": "example",
      "modalities": [
        "MODALITY_TEXT"
      ],
      "languagePreference": "en-US",
      "requestTimeoutSeconds": 1,
      "clearTools": true
    },
    "mcpServers": [
      {
        "serverId": "example_123",
        "enabled": true,
        "priority": 1,
        "allowlistToolPatterns": [
          "example"
        ],
        "blocklistToolPatterns": [
          "example"
        ]
      }
    ],
    "variableSpecs": [
      {
        "name": "example",
        "description": "example",
        "required": true,
        "defaultValue": "example",
        "type": "VAR_TYPE_STRING"
      }
    ],
    "version": 1
  }
}

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

Section	Stable reference
Get an agent profile	DOC-MA-profiles-prompts-api-getAgentProfile#overview
Request	DOC-MA-profiles-prompts-api-getAgentProfile#request
Responses	DOC-MA-profiles-prompts-api-getAgentProfile#responses