Create or Update Agent

Create or Update an Agent.

PUT /api/svc/v1/agents

Create or Update Agent

cURL

curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "manifest": {
    "name": "<string>",
    "description": "<string>",
    "model": "<string>",
    "collaborators": [
      {
        "subject": "<string>",
        "role_id": "<string>"
      }
    ],
    "tags": {},
    "model_params": {
      "max_tokens": 123,
      "temperature": 123,
      "top_p": 123
    },
    "skills": [
      {
        "fqn": "<string>",
        "preload_skill_md": false
      }
    ],
    "mcp_servers": [
      {
        "name": "<string>",
        "deferred": false,
        "tools": [
          {
            "name": "<string>"
          }
        ]
      }
    ],
    "instruction": "<string>",
    "messages": [
      {
        "content": "<string>"
      }
    ],
    "variables": {},
    "response_format": {},
    "iteration_limit": 99
  },
  "dryRun": false
}
'

200

{
  "data": {
    "name": "<string>",
    "fqn": "<string>",
    "tenantName": "<string>",
    "accountId": "<string>",
    "latestVersion": 123,
    "type": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>",
      "subjectPatName": "<string>",
      "subjectControllerName": "<string>",
      "subjectExternalIdentitySlug": "<string>"
    },
    "id": "<string>",
    "latestVersionDetails": {
      "agentId": "<string>",
      "fqn": "<string>",
      "manifest": {
        "name": "<string>",
        "description": "<string>",
        "model": "<string>",
        "collaborators": [
          {
            "subject": "<string>",
            "role_id": "<string>"
          }
        ],
        "tags": {},
        "model_params": {
          "max_tokens": 123,
          "temperature": 123,
          "top_p": 123
        },
        "skills": [
          {
            "fqn": "<string>",
            "preload_skill_md": false
          }
        ],
        "mcp_servers": [
          {
            "name": "<string>",
            "deferred": false,
            "tools": [
              {
                "name": "<string>"
              }
            ]
          }
        ],
        "instruction": "<string>",
        "messages": [
          {
            "content": "<string>"
          }
        ],
        "variables": {},
        "response_format": {},
        "sandbox": {
          "enabled": true
        },
        "iteration_limit": 99,
        "ownedBy": {
          "account": "<string>"
        }
      },
      "version": 123,
      "id": "<string>",
      "metadata": {},
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>",
        "subjectPatName": "<string>",
        "subjectControllerName": "<string>",
        "subjectExternalIdentitySlug": "<string>"
      }
    },
    "createdBy": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

manifest · TrueFoundryAgentManifest · object · required

Agent Manifest

TrueFoundryAgentManifest

RemoteAgent

LegacyAgentManifest

Show child attributes

dryRun · boolean | null · default: false

Validate the manifest and collaborators without persisting or syncing to the gateway store

Response

200

application/json

Agent created or updated successfully

data · Agent · object · required

Agent

Show child attributes