curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "truefoundry-agent",
"name": "<string>",
"description": "<string>",
"model": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"tags": {},
"model_params": {
"max_tokens": 123,
"reasoning_effort": "none",
"temperature": 123,
"top_p": 123
},
"skills": [
{
"fqn": "<string>",
"preload_skill_md": false
}
],
"mcp_servers": [
{
"name": "<string>",
"deferred": false,
"tools": [
{
"name": "<string>"
}
]
}
],
"instruction": "<string>",
"messages": [
{
"role": "user",
"content": "<string>"
}
],
"variables": {},
"response_format": {
"type": "text"
},
"iteration_limit": 99
},
"dryRun": false
}
'{
"data": {
"name": "<string>",
"fqn": "<string>",
"tenantName": "<string>",
"accountId": "<string>",
"latestVersion": 123,
"type": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"id": "<string>",
"latestVersionDetails": {
"agentId": "<string>",
"fqn": "<string>",
"manifest": {
"type": "truefoundry-agent",
"name": "<string>",
"description": "<string>",
"model": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"tags": {},
"model_params": {
"max_tokens": 123,
"reasoning_effort": "none",
"temperature": 123,
"top_p": 123
},
"skills": [
{
"fqn": "<string>",
"preload_skill_md": false
}
],
"mcp_servers": [
{
"name": "<string>",
"deferred": false,
"tools": [
{
"name": "<string>"
}
]
}
],
"instruction": "<string>",
"messages": [
{
"role": "user",
"content": "<string>"
}
],
"variables": {},
"response_format": {
"type": "text"
},
"sandbox": {
"enabled": true
},
"iteration_limit": 99,
"ownedBy": {
"account": "<string>"
}
},
"version": 123,
"id": "<string>",
"metadata": {},
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
}
},
"createdBy": "<string>"
}
}Create or Update an Agent.
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "truefoundry-agent",
"name": "<string>",
"description": "<string>",
"model": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"tags": {},
"model_params": {
"max_tokens": 123,
"reasoning_effort": "none",
"temperature": 123,
"top_p": 123
},
"skills": [
{
"fqn": "<string>",
"preload_skill_md": false
}
],
"mcp_servers": [
{
"name": "<string>",
"deferred": false,
"tools": [
{
"name": "<string>"
}
]
}
],
"instruction": "<string>",
"messages": [
{
"role": "user",
"content": "<string>"
}
],
"variables": {},
"response_format": {
"type": "text"
},
"iteration_limit": 99
},
"dryRun": false
}
'{
"data": {
"name": "<string>",
"fqn": "<string>",
"tenantName": "<string>",
"accountId": "<string>",
"latestVersion": 123,
"type": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"id": "<string>",
"latestVersionDetails": {
"agentId": "<string>",
"fqn": "<string>",
"manifest": {
"type": "truefoundry-agent",
"name": "<string>",
"description": "<string>",
"model": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"tags": {},
"model_params": {
"max_tokens": 123,
"reasoning_effort": "none",
"temperature": 123,
"top_p": 123
},
"skills": [
{
"fqn": "<string>",
"preload_skill_md": false
}
],
"mcp_servers": [
{
"name": "<string>",
"deferred": false,
"tools": [
{
"name": "<string>"
}
]
}
],
"instruction": "<string>",
"messages": [
{
"role": "user",
"content": "<string>"
}
],
"variables": {},
"response_format": {
"type": "text"
},
"sandbox": {
"enabled": true
},
"iteration_limit": 99,
"ownedBy": {
"account": "<string>"
}
},
"version": 123,
"id": "<string>",
"metadata": {},
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
}
},
"createdBy": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Agent created or updated successfully
Agent
Show child attributes
Was this page helpful?