Skip to content

Add agent management endpoints to Cloud Platform API #2399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexCatarino merged 1 commit into from
May 12, 2026
Merged

Add agent management endpoints to Cloud Platform API #2399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...tform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/01 Introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
Create a new agent.
</p>
273 changes: 273 additions & 0 deletions ...d Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/02 Request.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
<!-- Code generated by API-Reference-Code-Generator.py -->
<p>
Definition of the agent to create. The <code>/agents/create</code> API accepts requests in the following format:
</p>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>CreateAgentRequest</code> Model - Request body for creating an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">organizationId</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: 3b137fed57f2326cc68e746f4eb99639</sub></i></code> <br/> Identifier of the organization that will own the agent.</td>
</tr>
<tr>
<td width="20%">name</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: Creative Fluorescent Orange Parrot</sub></i></code> <br/> Name of the agent.</td>
</tr>
<tr>
<td width="20%">description</td> <td> <code>string</code> <br/> Short description of the agent.</td>
</tr>
<tr>
<td width="20%">profileImage</td> <td> <code>string</code> <br/> Filename of the agent's profile image.</td>
</tr>
<tr>
<td width="20%">systemPrompt</td> <td> <code>string</code> <br/> System prompt that defines the agent's behavior.</td>
</tr>
<tr>
<td width="20%">reasoningEffort</td> <td> <code>string Enum</code> <br/> Reasoning effort applied by the underlying model. Options : ['low', 'medium', 'high']</td>
</tr>
<tr>
<td width="20%">maxTurns</td> <td> <code>integer</code> <br/> Maximum number of agent turns allowed in a single deployment.</td>
</tr>
<tr>
<td width="20%">toolChoice</td> <td> <code>string<br/><i><sub>example: auto</sub></i></code> <br/> Tool selection policy for the agent.</td>
</tr>
<tr>
<td width="20%">tools</td> <td> <code>string Array</code> <br/> Identifiers of the tools available to the agent.</td>
</tr>
<tr>
<td width="20%">public</td> <td> <code>boolean</code> <br/> Whether the agent is shared publicly within the organization.</td>
</tr>
<tr>
<td width="20%">model</td> <td> <code>string<br/><i><sub>example: claude-opus-4-7</sub></i></code> <br/> Model identifier the agent runs on.</td>
</tr>
<tr>
<td width="20%">chainedAgents</td> <td> <code>AgentChainedEntry Array</code> <br/> Agents to chain after this one in a multi-agent pipeline.</td>
</tr>
<tr>
<td width="20%">subAgents</td> <td> <code>AgentSubAgentEntry Array</code> <br/> Sub-agents the new agent can invoke.</td>
</tr>
<tr>
<td width="20%">token</td> <td> <code>AgentToken object</code> <br/> User-supplied LLM provider credentials attached to an agent.</td>
</tr>
<tr>
<td width="20%">useQCC</td> <td> <code>boolean</code> <br/> Whether to run the agent on the QuantConnect Cloud LLM provider. When false, supply a token.</td>
</tr>
<tr>
<td width="20%">pipeline</td> <td> <code>string</code> <br/> Pipeline to assign to the agent.</td>
</tr>
<tr>
<td width="20%">author</td> <td> <code>AgentTaskOwner object</code> <br/> Owner of an agent task.</td>
</tr>
<tr>
<td width="20%">organization</td> <td> <code>AgentOrganization object</code> <br/> Organization summary embedded on an agent.</td>
</tr>
<tr>
<td width="20%">node</td> <td> <code>AgentNode object</code> <br/> Compute node bound to an agent.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"organizationId": "3b137fed57f2326cc68e746f4eb99639",
"name": "Creative Fluorescent Orange Parrot",
"description": "string",
"profileImage": "string",
"systemPrompt": "string",
"reasoningEffort": "low",
"maxTurns": 0,
"toolChoice": "auto",
"tools": [
"string"
],
"public": true,
"model": "claude-opus-4-7",
"chainedAgents": [
{
"agentId": 105,
"step": 1,
"agent":
}
],
"subAgents": [
{
"agentId": 105,
"callableCount": 1
}
],
"token": {
"llmApiTokenUser": "sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA",
"llmProviderApi": "anthropic"
},
"useQCC": true,
"pipeline": "string",
"author": {
"publicId": "alexandre_catarino",
"name": "Alexandre Catarino",
"image": "e76004d3a79bb421536616863.jpeg"
},
"organization": {
"id": "3b137fed57f2326cc68e746f4eb99639",
"name": "QuantConnect",
"profile": "167df5c7cd6b3171771270587.png"
},
"node": {
"id": 0,
"sku": "A-8"
}
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentChainedEntry</code> Model - One entry in an agent's chain of follow-up agents.</th>
</tr>
</thead>
<tr>
<td width="20%">agentId</td> <td> <code>integer<br/><i><sub>required</sub></i><br/><i><sub>example: 105</sub></i></code> <br/> Identifier of the chained agent.</td>
</tr>
<tr>
<td width="20%">step</td> <td> <code>integer<br/><i><sub>required</sub></i><br/><i><sub>example: 1</sub></i></code> <br/> Ordinal position of the agent in the chain.</td>
</tr>
<tr>
<td width="20%">agent</td> <td> <code>object</code> <br/> Embedded agent definition, populated when the chain entry is expanded.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"agentId": 105,
"step": 1,
"agent":
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentSubAgentEntry</code> Model - One sub-agent reference attached to an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">agentId</td> <td> <code>integer<br/><i><sub>required</sub></i><br/><i><sub>example: 105</sub></i></code> <br/> Identifier of the sub-agent.</td>
</tr>
<tr>
<td width="20%">callableCount</td> <td> <code>integer<br/><i><sub>example: 1</sub></i></code> <br/> Maximum number of times this sub-agent can be invoked per deployment.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"agentId": 105,
"callableCount": 1
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentToken</code> Model - User-supplied LLM provider credentials attached to an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">llmApiTokenUser</td> <td> <code>string<br/><i><sub>example: sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA</sub></i></code> <br/> API token supplied by the user for the chosen LLM provider.</td>
</tr>
<tr>
<td width="20%">llmProviderApi</td> <td> <code>string<br/><i><sub>example: anthropic</sub></i></code> <br/> Identifier of the LLM provider the token is for.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"llmApiTokenUser": "sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA",
"llmProviderApi": "anthropic"
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentTaskOwner</code> Model - Owner of an agent task.</th>
</tr>
</thead>
<tr>
<td width="20%">publicId</td> <td> <code>string<br/><i><sub>example: alexandre_catarino</sub></i></code> <br/> Public profile slug of the user.</td>
</tr>
<tr>
<td width="20%">name</td> <td> <code>string<br/><i><sub>example: Alexandre Catarino</sub></i></code> <br/> Display name of the user.</td>
</tr>
<tr>
<td width="20%">image</td> <td> <code>string<br/><i><sub>example: e76004d3a79bb421536616863.jpeg</sub></i></code> <br/> Filename of the user's profile image.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"publicId": "alexandre_catarino",
"name": "Alexandre Catarino",
"image": "e76004d3a79bb421536616863.jpeg"
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentOrganization</code> Model - Organization summary embedded on an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">id</td> <td> <code>string<br/><i><sub>example: 3b137fed57f2326cc68e746f4eb99639</sub></i></code> <br/> Identifier of the organization.</td>
</tr>
<tr>
<td width="20%">name</td> <td> <code>string<br/><i><sub>example: QuantConnect</sub></i></code> <br/> Display name of the organization.</td>
</tr>
<tr>
<td width="20%">profile</td> <td> <code>string<br/><i><sub>example: 167df5c7cd6b3171771270587.png</sub></i></code> <br/> Filename of the organization's profile image.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"id": "3b137fed57f2326cc68e746f4eb99639",
"name": "QuantConnect",
"profile": "167df5c7cd6b3171771270587.png"
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>AgentNode</code> Model - Compute node bound to an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">id</td> <td> <code>integer<br/><i><sub>example: 0</sub></i></code> <br/> Identifier of the compute node assigned to the agent, or 0 when not pinned.</td>
</tr>
<tr>
<td width="20%">sku</td> <td> <code>string<br/><i><sub>example: A-8</sub></i></code> <br/> SKU of the compute node assigned to the agent.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"id": 0,
"sku": "A-8"
}</pre>
</div>
</td>
</tr>
</table>
17 changes: 17 additions & 0 deletions ...Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/03 Responses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
The <code>/agents/create</code> API provides a response in the following format:
</p>
<h4>200 Success</h4>
<h4>401 Authentication Error</h4>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>UnauthorizedError</code> Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.</th>
</tr>
</thead>
<tr>
<td width="20%">www_authenticate</td> <td> <code>string</code> <br/> Header</td>
</tr>
</table>
0 ...t/01 Tasks/01 Create Task/99 Examples.php → ...01 Agents/01 Create Agent/99 Examples.php
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions ...latform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/01 Introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
Read an agent by Id.
</p>
24 changes: 24 additions & 0 deletions ...oud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/02 Request.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Code generated by API-Reference-Code-Generator.py -->
<p>
Id of the agent to read. The <code>/agents/read</code> API accepts requests in the following format:
</p>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>ReadAgentRequest</code> Model - Request body for reading an agent.</th>
</tr>
</thead>
<tr>
<td width="20%">agentId</td> <td> <code>integer<br/><i><sub>required</sub></i></code> <br/> Identifier of the agent to read.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"agentId": 0
}</pre>
</div>
</td>
</tr>
</table>
17 changes: 17 additions & 0 deletions ...d Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/03 Responses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
The <code>/agents/read</code> API provides a response in the following format:
</p>
<h4>200 Success</h4>
<h4>401 Authentication Error</h4>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>UnauthorizedError</code> Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.</th>
</tr>
</thead>
<tr>
<td width="20%">www_authenticate</td> <td> <code>string</code> <br/> Header</td>
</tr>
</table>
0 ...ent/01 Tasks/02 Read Task/99 Examples.php → ...t/01 Agents/02 Read Agent/99 Examples.php
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions ...tform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/01 Introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
Update an existing agent.
</p>
Loading