diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/01 Introduction.html new file mode 100644 index 0000000000..9c0cd5ab45 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/01 Introduction.html @@ -0,0 +1,5 @@ + + +

+Create a new agent. +

diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/02 Request.html new file mode 100644 index 0000000000..82912428be --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/02 Request.html @@ -0,0 +1,273 @@ + +

+Definition of the agent to create. The /agents/create API accepts requests in the following format: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CreateAgentRequest Model - Request body for creating an agent.
organizationId string
required
example: 3b137fed57f2326cc68e746f4eb99639
Identifier of the organization that will own the agent.
name string
required
example: Creative Fluorescent Orange Parrot
Name of the agent.
description string
Short description of the agent.
profileImage string
Filename of the agent's profile image.
systemPrompt string
System prompt that defines the agent's behavior.
reasoningEffort string Enum
Reasoning effort applied by the underlying model. Options : ['low', 'medium', 'high']
maxTurns integer
Maximum number of agent turns allowed in a single deployment.
toolChoice string
example: auto
Tool selection policy for the agent.
tools string Array
Identifiers of the tools available to the agent.
public boolean
Whether the agent is shared publicly within the organization.
model string
example: claude-opus-4-7
Model identifier the agent runs on.
chainedAgents AgentChainedEntry Array
Agents to chain after this one in a multi-agent pipeline.
subAgents AgentSubAgentEntry Array
Sub-agents the new agent can invoke.
token AgentToken object
User-supplied LLM provider credentials attached to an agent.
useQCC boolean
Whether to run the agent on the QuantConnect Cloud LLM provider. When false, supply a token.
pipeline string
Pipeline to assign to the agent.
author AgentTaskOwner object
Owner of an agent task.
organization AgentOrganization object
Organization summary embedded on an agent.
node AgentNode object
Compute node bound to an agent.
Example +
+{
+  "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"
+  }
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentChainedEntry Model - One entry in an agent's chain of follow-up agents.
agentId integer
required
example: 105
Identifier of the chained agent.
step integer
required
example: 1
Ordinal position of the agent in the chain.
agent object
Embedded agent definition, populated when the chain entry is expanded.
Example +
+{
+  "agentId": 105,
+  "step": 1,
+  "agent": 
+}
+
+
+ + + + + + + + + + + + + + + +
AgentSubAgentEntry Model - One sub-agent reference attached to an agent.
agentId integer
required
example: 105
Identifier of the sub-agent.
callableCount integer
example: 1
Maximum number of times this sub-agent can be invoked per deployment.
Example +
+{
+  "agentId": 105,
+  "callableCount": 1
+}
+
+
+ + + + + + + + + + + + + + + +
AgentToken Model - User-supplied LLM provider credentials attached to an agent.
llmApiTokenUser string
example: sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA
API token supplied by the user for the chosen LLM provider.
llmProviderApi string
example: anthropic
Identifier of the LLM provider the token is for.
Example +
+{
+  "llmApiTokenUser": "sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA",
+  "llmProviderApi": "anthropic"
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentTaskOwner Model - Owner of an agent task.
publicId string
example: alexandre_catarino
Public profile slug of the user.
name string
example: Alexandre Catarino
Display name of the user.
image string
example: e76004d3a79bb421536616863.jpeg
Filename of the user's profile image.
Example +
+{
+  "publicId": "alexandre_catarino",
+  "name": "Alexandre Catarino",
+  "image": "e76004d3a79bb421536616863.jpeg"
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentOrganization Model - Organization summary embedded on an agent.
id string
example: 3b137fed57f2326cc68e746f4eb99639
Identifier of the organization.
name string
example: QuantConnect
Display name of the organization.
profile string
example: 167df5c7cd6b3171771270587.png
Filename of the organization's profile image.
Example +
+{
+  "id": "3b137fed57f2326cc68e746f4eb99639",
+  "name": "QuantConnect",
+  "profile": "167df5c7cd6b3171771270587.png"
+}
+
+
+ + + + + + + + + + + + + + + +
AgentNode Model - Compute node bound to an agent.
id integer
example: 0
Identifier of the compute node assigned to the agent, or 0 when not pinned.
sku string
example: A-8
SKU of the compute node assigned to the agent.
Example +
+{
+  "id": 0,
+  "sku": "A-8"
+}
+
+
\ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/03 Responses.html new file mode 100644 index 0000000000..af118fbeec --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/03 Responses.html @@ -0,0 +1,17 @@ + + +

+The /agents/create API provides a response in the following format: +

+

200 Success

+

401 Authentication Error

+ + + + + + + + + +
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header
diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/01 Create Agent/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/01 Introduction.html new file mode 100644 index 0000000000..7eddcc8fba --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/01 Introduction.html @@ -0,0 +1,5 @@ + + +

+Read an agent by Id. +

diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/02 Request.html new file mode 100644 index 0000000000..fe620061e2 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/02 Request.html @@ -0,0 +1,24 @@ + +

+Id of the agent to read. The /agents/read API accepts requests in the following format: +

+ + + + + + + + + + + + + +
ReadAgentRequest Model - Request body for reading an agent.
agentId integer
required
Identifier of the agent to read.
Example +
+{
+  "agentId": 0
+}
+
+
\ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/03 Responses.html new file mode 100644 index 0000000000..829510f28a --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/03 Responses.html @@ -0,0 +1,17 @@ + + +

+The /agents/read API provides a response in the following format: +

+

200 Success

+

401 Authentication Error

+ + + + + + + + + +
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header
diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/02 Read Agent/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/01 Introduction.html new file mode 100644 index 0000000000..f77c4fbc7e --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/01 Introduction.html @@ -0,0 +1,5 @@ + + +

+Update an existing agent. +

diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/02 Request.html new file mode 100644 index 0000000000..ae945e4dc5 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/02 Request.html @@ -0,0 +1,273 @@ + +

+Id of the agent to update and the fields to change. The /agents/update API accepts requests in the following format: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UpdateAgentRequest Model - Request body for updating an agent.
agentId integer
required
Identifier of the agent to update.
name string
New name for the agent.
description string
New description for the agent.
profileImage string
New profile image filename for the agent.
systemPrompt string
New system prompt for the agent.
reasoningEffort string Enum
New reasoning effort for the agent. Options : ['low', 'medium', 'high']
maxTurns integer
New maximum number of agent turns per deployment.
toolChoice string
New tool selection policy for the agent.
tools string Array
New list of tools available to the agent.
public boolean
Whether the agent should be shared publicly within the organization.
model string
example: claude-opus-4-7
New model identifier for the agent.
chainedAgents AgentChainedEntry Array
New chain of agents to invoke after this one.
subAgents AgentSubAgentEntry Array
New list of sub-agents the agent can invoke.
token AgentToken object
User-supplied LLM provider credentials attached to an agent.
useQCC boolean
Whether to run the agent on the QuantConnect Cloud LLM provider. When false, supply a token.
pipeline string
New pipeline to assign to the agent.
author AgentTaskOwner object
Owner of an agent task.
organization AgentOrganization object
Organization summary embedded on an agent.
node AgentNode object
Compute node bound to an agent.
Example +
+{
+  "agentId": 0,
+  "name": "string",
+  "description": "string",
+  "profileImage": "string",
+  "systemPrompt": "string",
+  "reasoningEffort": "low",
+  "maxTurns": 0,
+  "toolChoice": "string",
+  "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"
+  }
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentChainedEntry Model - One entry in an agent's chain of follow-up agents.
agentId integer
required
example: 105
Identifier of the chained agent.
step integer
required
example: 1
Ordinal position of the agent in the chain.
agent object
Embedded agent definition, populated when the chain entry is expanded.
Example +
+{
+  "agentId": 105,
+  "step": 1,
+  "agent": 
+}
+
+
+ + + + + + + + + + + + + + + +
AgentSubAgentEntry Model - One sub-agent reference attached to an agent.
agentId integer
required
example: 105
Identifier of the sub-agent.
callableCount integer
example: 1
Maximum number of times this sub-agent can be invoked per deployment.
Example +
+{
+  "agentId": 105,
+  "callableCount": 1
+}
+
+
+ + + + + + + + + + + + + + + +
AgentToken Model - User-supplied LLM provider credentials attached to an agent.
llmApiTokenUser string
example: sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA
API token supplied by the user for the chosen LLM provider.
llmProviderApi string
example: anthropic
Identifier of the LLM provider the token is for.
Example +
+{
+  "llmApiTokenUser": "sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA",
+  "llmProviderApi": "anthropic"
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentTaskOwner Model - Owner of an agent task.
publicId string
example: alexandre_catarino
Public profile slug of the user.
name string
example: Alexandre Catarino
Display name of the user.
image string
example: e76004d3a79bb421536616863.jpeg
Filename of the user's profile image.
Example +
+{
+  "publicId": "alexandre_catarino",
+  "name": "Alexandre Catarino",
+  "image": "e76004d3a79bb421536616863.jpeg"
+}
+
+
+ + + + + + + + + + + + + + + + + + +
AgentOrganization Model - Organization summary embedded on an agent.
id string
example: 3b137fed57f2326cc68e746f4eb99639
Identifier of the organization.
name string
example: QuantConnect
Display name of the organization.
profile string
example: 167df5c7cd6b3171771270587.png
Filename of the organization's profile image.
Example +
+{
+  "id": "3b137fed57f2326cc68e746f4eb99639",
+  "name": "QuantConnect",
+  "profile": "167df5c7cd6b3171771270587.png"
+}
+
+
+ + + + + + + + + + + + + + + +
AgentNode Model - Compute node bound to an agent.
id integer
example: 0
Identifier of the compute node assigned to the agent, or 0 when not pinned.
sku string
example: A-8
SKU of the compute node assigned to the agent.
Example +
+{
+  "id": 0,
+  "sku": "A-8"
+}
+
+
\ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/03 Responses.html new file mode 100644 index 0000000000..c208b34b87 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/03 Responses.html @@ -0,0 +1,42 @@ + + +

+The /agents/update API provides a response in the following format: +

+

200 Success

+ + + + + + + + + + + + + + + + +
RestResponse Model - Base API response class for the QuantConnect API.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example +
+{
+  "success": true,
+  "errors": [
+    "string"
+  ]
+}
+
+

401 Authentication Error

+ + + + + + + + + +
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header
diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/03 Update Agent/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/01 Introduction.html new file mode 100644 index 0000000000..cbb56acca3 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/01 Introduction.html @@ -0,0 +1,5 @@ + + +

+Delete an agent. +

diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/02 Request.html new file mode 100644 index 0000000000..5fb79b4972 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/02 Request.html @@ -0,0 +1,24 @@ + +

+Id of the agent to delete. The /agents/delete API accepts requests in the following format: +

+ + + + + + + + + + + + + +
DeleteAgentRequest Model - Request body for deleting an agent.
agentId integer
required
Identifier of the agent to delete.
Example +
+{
+  "agentId": 0
+}
+
+
\ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/03 Responses.html new file mode 100644 index 0000000000..bd86918634 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/03 Responses.html @@ -0,0 +1,42 @@ + + +

+The /agents/delete API provides a response in the following format: +

+

200 Success

+ + + + + + + + + + + + + + + + +
RestResponse Model - Base API response class for the QuantConnect API.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example +
+{
+  "success": true,
+  "errors": [
+    "string"
+  ]
+}
+
+

401 Authentication Error

+ + + + + + + + + +
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header
diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/04 Delete Agent/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/01 Introduction.html new file mode 100644 index 0000000000..85c4ae2383 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/01 Introduction.html @@ -0,0 +1,5 @@ + + +

+List the agents of an organization. +

diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/02 Request.html new file mode 100644 index 0000000000..57c93cd56e --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/02 Request.html @@ -0,0 +1,24 @@ + +

+Id of the organization whose agents to list. The /agents/list API accepts requests in the following format: +

+ + + + + + + + + + + + + +
ListAgentsRequest Model - Request body for listing the agents of an organization.
organizationId string
required
Identifier of the organization whose agents to list.
Example +
+{
+  "organizationId": "string"
+}
+
+
\ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/03 Responses.html new file mode 100644 index 0000000000..56b6248133 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/03 Responses.html @@ -0,0 +1,17 @@ + + +

+The /agents/list API provides a response in the following format: +

+

200 Success

+

401 Authentication Error

+ + + + + + + + + +
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header
diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/01 Agents/05 List Agents/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/01 Create Task/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/01 Create Task/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/02 Read Task/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/02 Read Task/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/03 Update Task/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/03 Update Task/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/04 Delete Task/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/04 Delete Task/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/05 List Tasks/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/02 Tasks/05 List Tasks/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/01 Create Deployment/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/01 Create Deployment/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/02 Read Deployment/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/99 Examples.php similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/02 Read Deployment/99 Examples.php diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/03 Update Deployment/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/99 Examples.php similarity index 91% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/99 Examples.php index cfd3579f42..ef05c4e20f 100644 --- a/01 Cloud Platform/99 API Reference/14 Agent Management/01 Tasks/99 Examples.php +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/03 Update Deployment/99 Examples.php @@ -1 +1 @@ - + \ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/04 List Deployments/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/99 Examples.php similarity index 91% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/99 Examples.php rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/99 Examples.php index cfd3579f42..ef05c4e20f 100644 --- a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/99 Examples.php +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/04 List Deployments/99 Examples.php @@ -1 +1 @@ - + \ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/05 Stop Deployment/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/99 Examples.php new file mode 100644 index 0000000000..ef05c4e20f --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/05 Stop Deployment/99 Examples.php @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/06 Delete Deployment/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/99 Examples.php new file mode 100644 index 0000000000..ef05c4e20f --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/06 Delete Deployment/99 Examples.php @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/01 Introduction.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/01 Introduction.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/01 Introduction.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/01 Introduction.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/02 Request.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/02 Request.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/02 Request.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/02 Request.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/03 Responses.html b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/03 Responses.html similarity index 100% rename from 01 Cloud Platform/99 API Reference/14 Agent Management/02 Deployments/07 Read Conversation/03 Responses.html rename to 01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/03 Responses.html diff --git a/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/99 Examples.php b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/99 Examples.php new file mode 100644 index 0000000000..ef05c4e20f --- /dev/null +++ b/01 Cloud Platform/99 API Reference/14 Agent Management/03 Deployments/07 Read Conversation/99 Examples.php @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/QuantConnect-Platform-2.0.0.yaml b/QuantConnect-Platform-2.0.0.yaml index f4bea39c9b..3c8e9828cb 100644 --- a/QuantConnect-Platform-2.0.0.yaml +++ b/QuantConnect-Platform-2.0.0.yaml @@ -1543,13 +1543,143 @@ paths: "401": $ref: '#/components/responses/UnauthorizedErrorResponse' operationId: searchAITool + /agents/create: + post: + tags: + - 01 Cloud Platform + - 99 API Reference + - 14 Agent Management + - 01 Agents + - 01 Create Agent + summary: Create a new agent. + requestBody: + description: Definition of the agent to create. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAgentRequest' + required: true + responses: + "200": + description: The created agent. + content: + application/json: + schema: + $ref: '#/components/schemas/AgentResponse' + "401": + $ref: '#/components/responses/UnauthorizedErrorResponse' + operationId: createAgent + /agents/read: + post: + tags: + - 01 Cloud Platform + - 99 API Reference + - 14 Agent Management + - 01 Agents + - 02 Read Agent + summary: Read an agent by Id. + requestBody: + description: Id of the agent to read. + content: + application/json: + schema: + $ref: '#/components/schemas/ReadAgentRequest' + required: true + responses: + "200": + description: The agent. + content: + application/json: + schema: + $ref: '#/components/schemas/AgentResponse' + "401": + $ref: '#/components/responses/UnauthorizedErrorResponse' + operationId: readAgent + /agents/update: + post: + tags: + - 01 Cloud Platform + - 99 API Reference + - 14 Agent Management + - 01 Agents + - 03 Update Agent + summary: Update an existing agent. + requestBody: + description: Id of the agent to update and the fields to change. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAgentRequest' + required: true + responses: + "200": + description: Base API response. + content: + application/json: + schema: + $ref: '#/components/schemas/RestResponse' + "401": + $ref: '#/components/responses/UnauthorizedErrorResponse' + operationId: updateAgent + /agents/delete: + post: + tags: + - 01 Cloud Platform + - 99 API Reference + - 14 Agent Management + - 01 Agents + - 04 Delete Agent + summary: Delete an agent. + requestBody: + description: Id of the agent to delete. + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteAgentRequest' + required: true + responses: + "200": + description: Base API response. + content: + application/json: + schema: + $ref: '#/components/schemas/RestResponse' + "401": + $ref: '#/components/responses/UnauthorizedErrorResponse' + operationId: deleteAgent + /agents/list: + post: + tags: + - 01 Cloud Platform + - 99 API Reference + - 14 Agent Management + - 01 Agents + - 05 List Agents + summary: List the agents of an organization. + requestBody: + description: Id of the organization whose agents to list. + content: + application/json: + schema: + $ref: '#/components/schemas/ListAgentsRequest' + required: true + responses: + "200": + description: Agents belonging to the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/AgentListResponse' + "401": + $ref: '#/components/responses/UnauthorizedErrorResponse' + operationId: listAgents /agents/tasks/create: post: tags: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 01 Tasks + - 02 Tasks - 01 Create Task summary: Create a new agent task. requestBody: @@ -1575,7 +1705,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 01 Tasks + - 02 Tasks - 02 Read Task summary: Read an agent task by Id. requestBody: @@ -1601,7 +1731,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 01 Tasks + - 02 Tasks - 03 Update Task summary: Update an agent task. requestBody: @@ -1627,7 +1757,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 01 Tasks + - 02 Tasks - 04 Delete Task summary: Delete an agent task. requestBody: @@ -1653,7 +1783,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 01 Tasks + - 02 Tasks - 05 List Tasks summary: List the agent tasks of an organization. requestBody: @@ -1679,7 +1809,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 01 Create Deployment summary: Deploy an agent task. requestBody: @@ -1705,7 +1835,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 02 Read Deployment summary: Read an agent deployment by Id. requestBody: @@ -1731,7 +1861,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 03 Update Deployment summary: Send a follow-up prompt to a running agent deployment. requestBody: @@ -1757,7 +1887,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 04 List Deployments summary: List the deployments of an agent task. requestBody: @@ -1783,7 +1913,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 05 Stop Deployment summary: Stop a running agent deployment. requestBody: @@ -1809,7 +1939,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 06 Delete Deployment summary: Delete an agent deployment. requestBody: @@ -1835,7 +1965,7 @@ paths: - 01 Cloud Platform - 99 API Reference - 14 Agent Management - - 02 Deployments + - 03 Deployments - 07 Read Conversation summary: Read the conversation transcript of an agent deployment. requestBody: @@ -7407,6 +7537,188 @@ components: oneOf: - $ref: '#/components/schemas/LoadingResponse' - $ref: '#/components/schemas/ReadChartResponse' + AgentOrganization: + type: object + properties: + id: + type: string + description: Identifier of the organization. + examples: + - 3b137fed57f2326cc68e746f4eb99639 + name: + type: string + description: Display name of the organization. + examples: + - QuantConnect + profile: + type: string + description: Filename of the organization's profile image. + examples: + - 167df5c7cd6b3171771270587.png + description: Organization summary embedded on an agent. + AgentNode: + type: object + properties: + id: + type: integer + description: Identifier of the compute node assigned to the agent, or 0 when not pinned. + examples: + - 0 + sku: + type: string + description: SKU of the compute node assigned to the agent. + examples: + - A-8 + description: Compute node bound to an agent. + AgentToken: + type: object + properties: + llmApiTokenUser: + type: string + description: API token supplied by the user for the chosen LLM provider. + examples: + - sk-ant-api03-u78VgglQR-EkS-ymkG0QPoSJMl7G0z6mwC5Z3LrpAZ88TCdGpAVa1TQ4SzKIhh3aPhmrmI_A-tznXzcKcRQTBTkXaiVv4AA + llmProviderApi: + type: string + description: Identifier of the LLM provider the token is for. + examples: + - anthropic + description: User-supplied LLM provider credentials attached to an agent. + AgentChainedEntry: + type: object + required: + - agentId + - step + properties: + agentId: + type: integer + description: Identifier of the chained agent. + examples: + - 105 + step: + type: integer + description: Ordinal position of the agent in the chain. + examples: + - 1 + agent: + type: object + description: Embedded agent definition, populated when the chain entry is expanded. + description: One entry in an agent's chain of follow-up agents. + AgentSubAgentEntry: + type: object + required: + - agentId + properties: + agentId: + type: integer + description: Identifier of the sub-agent. + examples: + - 105 + callableCount: + type: integer + description: Maximum number of times this sub-agent can be invoked per deployment. + examples: + - 1 + description: One sub-agent reference attached to an agent. + Agent: + type: object + properties: + id: + type: integer + description: Identifier of the agent. + examples: + - 105 + name: + type: string + description: Name of the agent. + examples: + - Creative Fluorescent Orange Parrot + description: + type: string + description: Short description of the agent. + examples: + - Customize your assistant's capabilities. + profileImage: + type: string + description: Filename of the agent's profile image. + examples: + - 383f0047f1238ca1773795440.png + systemPrompt: + type: string + description: System prompt that defines the agent's behavior. + reasoningEffort: + type: string + description: Reasoning effort applied by the underlying model. + enum: + - low + - medium + - high + examples: + - high + maxTurns: + type: integer + description: Maximum number of agent turns allowed in a single deployment. + examples: + - 100 + toolChoice: + type: string + description: Tool selection policy for the agent. + examples: + - auto + tools: + type: array + description: Identifiers of the tools available to the agent. + items: + type: string + public: + type: boolean + description: Whether the agent is shared publicly within the organization. + model: + type: [string, "null"] + description: Model identifier the agent runs on, or null to use the organization default. + examples: + - claude-opus-4-7 + pipeline: + type: [string, "null"] + description: Pipeline assigned to the agent, when set. + outputSchema: + type: [object, "null"] + description: JSON schema describing the agent's structured output, when set. + created: + type: string + description: Creation timestamp. + examples: + - '2026-05-12 17:08:53' + updated: + type: string + description: Last-updated timestamp. + examples: + - '2026-05-12 17:08:53' + author: + $ref: '#/components/schemas/AgentTaskOwner' + organization: + $ref: '#/components/schemas/AgentOrganization' + chainedAgents: + type: array + description: Agents chained after this one in a multi-agent pipeline. + items: + $ref: '#/components/schemas/AgentChainedEntry' + subAgents: + type: array + description: Sub-agents invoked by this agent. + items: + $ref: '#/components/schemas/AgentSubAgentEntry' + token: + oneOf: + - $ref: '#/components/schemas/AgentToken' + - type: "null" + description: LLM provider credentials attached to the agent, or null when the QuantConnect Cloud provider is used. + useQCC: + type: boolean + description: Whether the agent runs on the QuantConnect Cloud LLM provider instead of a user-supplied token. + node: + $ref: '#/components/schemas/AgentNode' + description: An agent definition. AgentTaskOwner: type: object properties: @@ -7685,6 +7997,201 @@ components: examples: - Running description: Full conversation transcript and metadata for an agent deployment. + CreateAgentRequest: + type: object + required: + - organizationId + - name + properties: + organizationId: + type: string + description: Identifier of the organization that will own the agent. + examples: + - 3b137fed57f2326cc68e746f4eb99639 + name: + type: string + description: Name of the agent. + examples: + - Creative Fluorescent Orange Parrot + description: + type: string + description: Short description of the agent. + profileImage: + type: string + description: Filename of the agent's profile image. + systemPrompt: + type: string + description: System prompt that defines the agent's behavior. + reasoningEffort: + type: string + description: Reasoning effort applied by the underlying model. + enum: + - low + - medium + - high + maxTurns: + type: integer + description: Maximum number of agent turns allowed in a single deployment. + toolChoice: + type: string + description: Tool selection policy for the agent. + examples: + - auto + tools: + type: array + description: Identifiers of the tools available to the agent. + items: + type: string + public: + type: boolean + description: Whether the agent is shared publicly within the organization. + model: + type: string + description: Model identifier the agent runs on. + examples: + - claude-opus-4-7 + chainedAgents: + type: array + description: Agents to chain after this one in a multi-agent pipeline. + items: + $ref: '#/components/schemas/AgentChainedEntry' + subAgents: + type: array + description: Sub-agents the new agent can invoke. + items: + $ref: '#/components/schemas/AgentSubAgentEntry' + token: + $ref: '#/components/schemas/AgentToken' + useQCC: + type: boolean + description: Whether to run the agent on the QuantConnect Cloud LLM provider. When false, supply a token. + pipeline: + type: string + description: Pipeline to assign to the agent. + author: + $ref: '#/components/schemas/AgentTaskOwner' + organization: + $ref: '#/components/schemas/AgentOrganization' + node: + $ref: '#/components/schemas/AgentNode' + description: Request body for creating an agent. + ReadAgentRequest: + type: object + required: + - agentId + properties: + agentId: + type: integer + description: Identifier of the agent to read. + description: Request body for reading an agent. + UpdateAgentRequest: + type: object + required: + - agentId + properties: + agentId: + type: integer + description: Identifier of the agent to update. + name: + type: string + description: New name for the agent. + description: + type: string + description: New description for the agent. + profileImage: + type: string + description: New profile image filename for the agent. + systemPrompt: + type: string + description: New system prompt for the agent. + reasoningEffort: + type: string + description: New reasoning effort for the agent. + enum: + - low + - medium + - high + maxTurns: + type: integer + description: New maximum number of agent turns per deployment. + toolChoice: + type: string + description: New tool selection policy for the agent. + tools: + type: array + description: New list of tools available to the agent. + items: + type: string + public: + type: boolean + description: Whether the agent should be shared publicly within the organization. + model: + type: string + description: New model identifier for the agent. + examples: + - claude-opus-4-7 + chainedAgents: + type: array + description: New chain of agents to invoke after this one. + items: + $ref: '#/components/schemas/AgentChainedEntry' + subAgents: + type: array + description: New list of sub-agents the agent can invoke. + items: + $ref: '#/components/schemas/AgentSubAgentEntry' + token: + $ref: '#/components/schemas/AgentToken' + useQCC: + type: boolean + description: Whether to run the agent on the QuantConnect Cloud LLM provider. When false, supply a token. + pipeline: + type: string + description: New pipeline to assign to the agent. + author: + $ref: '#/components/schemas/AgentTaskOwner' + organization: + $ref: '#/components/schemas/AgentOrganization' + node: + $ref: '#/components/schemas/AgentNode' + description: Request body for updating an agent. + DeleteAgentRequest: + type: object + required: + - agentId + properties: + agentId: + type: integer + description: Identifier of the agent to delete. + description: Request body for deleting an agent. + ListAgentsRequest: + type: object + required: + - organizationId + properties: + organizationId: + type: string + description: Identifier of the organization whose agents to list. + description: Request body for listing the agents of an organization. + AgentResponse: + allOf: + - $ref: '#/components/schemas/RestResponse' + - type: object + properties: + agent: + $ref: '#/components/schemas/Agent' + description: Response wrapping a single agent. + AgentListResponse: + allOf: + - $ref: '#/components/schemas/RestResponse' + - type: object + properties: + agents: + type: array + description: Agents belonging to the organization. + items: + $ref: '#/components/schemas/Agent' + description: Response wrapping the list of agents for an organization. CreateAgentTaskRequest: type: object required: diff --git a/Resources/qc-api/examples/agent-management.php b/Resources/qc-api/examples/agent-management.php index 0504b47ff1..c09e8465ea 100644 --- a/Resources/qc-api/examples/agent-management.php +++ b/Resources/qc-api/examples/agent-management.php @@ -1,8 +1,83 @@ -

The following example demonstrates creating, reading, updating, deleting, and listing agent tasks; deploying a task; and reading, prompting, stopping, and deleting a deployment through the cloud API.

+

The following example demonstrates listing, creating, reading, and updating an agent; creating, reading, updating, deleting, and listing agent tasks; deploying a task; and reading, prompting, stopping, and deleting a deployment through the cloud API.


 
+### List Agents
+# Send a POST request to the /agents/list endpoint to check for an existing "My Claude" agent
+response = post(f'{BASE_URL}/agents/list', headers=get_headers(), json={
+    "organizationId": ORGANIZATION_ID  # Organization whose agents to list
+})
+# Parse the JSON response into python managable dict
+result = response.json()
+# Search the returned agents for one already named "My Claude"
+my_claude = next((a for a in result.get('agents', []) if a['name'] == 'My Claude'), None)
+# Check if the request was successful and print the list
+if result['success']:
+    print("List of Agents:")
+    print(result)
+
+### Create Agent (only when "My Claude" does not exist yet)
+if not my_claude:
+    # Send a POST request to the /agents/create endpoint to create a new agent
+    response = post(f'{BASE_URL}/agents/create', headers=get_headers(), json={
+        "organizationId": ORGANIZATION_ID,                        # Organization that owns the agent
+        "name": "Agent Placeholder",                              # Placeholder name; renamed below
+        "description": "Customize your assistant's capabilities.",
+        "systemPrompt": "I am a bot",                             # System prompt for the agent
+        "model": "claude-opus-4-7",                               # Model identifier the agent runs on
+        "reasoningEffort": "high",                                # Reasoning effort: low | medium | high
+        "maxTurns": 100,                                          # Max agent turns per deployment
+        "toolChoice": "auto",                                     # Tool selection policy
+        "public": False,                                          # Keep the agent private
+        "useQCC": True                                            # Use the QuantConnect Cloud LLM provider
+    })
+    # Parse the JSON response into python managable dict
+    result = response.json()
+    # Capture the created agent
+    my_claude = result['agent']
+    # Check if the request was successful and print the result
+    if result['success']:
+        print("Agent Created Successfully:")
+        print(result)
+
+    ### Update Agent (rename the new agent to "My Claude")
+    # Send a POST request to the /agents/update endpoint to rename the agent
+    response = post(f'{BASE_URL}/agents/update', headers=get_headers(), json={
+        "agentId": my_claude['id'],  # ID of the agent to update
+        "name": "My Claude"          # New name for the agent
+    })
+    # Parse the JSON response into python managable dict
+    result = response.json()
+    # Check if the request was successful and print the result
+    if result['success']:
+        print("Agent Updated Successfully:")
+        print(result)
+
+# Capture the agent ID for downstream calls
+agent_id = my_claude['id']
+
+### Read Agent
+# Send a POST request to the /agents/read endpoint and check the model the agent runs on
+response = post(f'{BASE_URL}/agents/read', headers=get_headers(), json={
+    "agentId": agent_id  # ID of the agent to read
+})
+# Parse the JSON response into python managable dict
+result = response.json()
+# Check if the request was successful and print the agent's model
+if result['success']:
+    print(f"Agent model: {result['agent']['model']}")
+    print(result)
+
+### Delete Agent (left here for reference; uncomment to delete the agent)
+# response = post(f'{BASE_URL}/agents/delete', headers=get_headers(), json={
+#     "agentId": agent_id  # ID of the agent to delete
+# })
+# result = response.json()
+# if result['success']:
+#     print("Agent Deleted Successfully:")
+#     print(result)
+
 ### Create Task
 # Send a POST request to the /agents/tasks/create endpoint to create a task
 response = post(f'{BASE_URL}/agents/tasks/create', headers=get_headers(), json={