Skip to main content

List agent profiles

POST 
/api/v1/agent-profiles/list

Returns a paginated collection of full profile records for inspection or editing. For a lightweight selection view, use library, which omits runtime 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: Build a reusable assistant profile

Request​

Responses​

Page of profiles

Read a bounded first page from the project library.​

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

Request example

{
  "page": 1,
  "pageSize": 20
}

Guide request for Variant: inventory profiles before a shared change. Replace example resource identifiers with your own authorized values.​

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

Request example

{
  "page": 1,
  "pageSize": 25
}

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

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

Response example

{
  "profiles": [
    {
      "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
    }
  ],
  "totalCount": 1,
  "hasMore": true
}

Illustrative response for Variant: inventory profiles before a shared change. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-MA-profiles-prompts-api-listAgentProfiles#example-cookbook-managed-agents-profiles-prompts-index-json-05-response

Response example

{
  "profiles": [
    {
      "profileId": "nutrition_coach",
      "name": "Nutrition Coach",
      "version": 3
    }
  ],
  "totalCount": 1,
  "hasMore": false
}

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

SectionStable reference
List agent profilesDOC-MA-profiles-prompts-api-listAgentProfiles#overview
RequestDOC-MA-profiles-prompts-api-listAgentProfiles#request
ResponsesDOC-MA-profiles-prompts-api-listAgentProfiles#responses