blob: 6eb512d73cba4dc646615951ba4b2350750efe23 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="agentregistry_v1.html">Agent Registry API</a> . <a href="agentregistry_v1.projects.html">projects</a> . <a href="agentregistry_v1.projects.locations.html">locations</a> . <a href="agentregistry_v1.projects.locations.aiApplications.html">aiApplications</a> . <a href="agentregistry_v1.projects.locations.aiApplications.agents.html">agents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Agent under an AI Application.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Agents under an AI Application.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Agent under an AI Application.
Args:
name: string, Required. Name of the resource. Format: `projects/{project}/locations/{location}/aiApplications/{ai_application}/agents/{agent}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Agent. &quot;A2A&quot; below refers to the Agent-to-Agent protocol.
&quot;agentId&quot;: &quot;A String&quot;, # Output only. A stable, globally unique identifier for agents.
&quot;attributes&quot;: { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {&quot;framework&quot;: &quot;google-adk&quot;} - the agent framework used to develop the Agent. Example values: &quot;google-adk&quot;, &quot;langchain&quot;, &quot;custom&quot;. * `agentregistry.googleapis.com/system/RuntimeIdentity`: {&quot;principal&quot;: &quot;principal://...&quot;} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {&quot;uri&quot;: &quot;//...&quot;} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;card&quot;: { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
&quot;content&quot;: { # Output only. The content of the agent card.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of agent card.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the agent, often obtained from the A2A Agent Card.
&quot;location&quot;: &quot;A String&quot;, # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
&quot;protocols&quot;: [ # Output only. The connection details for the Agent.
{ # Represents the protocol of an Agent.
&quot;interfaces&quot;: [ # Output only. The connection details for the Agent.
{ # Represents the connection details for an Agent or MCP Server.
&quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding of the interface.
&quot;url&quot;: &quot;A String&quot;, # Required. The destination URL.
},
],
&quot;protocolVersion&quot;: &quot;A String&quot;, # Output only. The version of the protocol, for example, the A2A Agent Card version.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the protocol.
},
],
&quot;skills&quot;: [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
{ # Represents the skills of an Agent.
&quot;description&quot;: &quot;A String&quot;, # Output only. A more detailed description of the skill.
&quot;examples&quot;: [ # Output only. Example prompts or scenarios this skill can handle.
&quot;A String&quot;,
],
&quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for the agent&#x27;s skill.
&quot;name&quot;: &quot;A String&quot;, # Output only. A human-readable name for the agent&#x27;s skill.
&quot;tags&quot;: [ # Output only. Keywords describing the skill.
&quot;A String&quot;,
],
},
],
&quot;uid&quot;: &quot;A String&quot;, # Output only. A universally unique identifier for the Agent.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time.
&quot;version&quot;: &quot;A String&quot;, # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Agents under an AI Application.
Args:
parent: string, Required. Parent value (AI Application) for ListAiApplicationAgentsRequest. Format: `projects/{project}/locations/{location}/aiApplications/{ai_application}` (required)
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Agents under an AI Application.
&quot;agents&quot;: [ # The list of Agents.
{ # Represents an Agent. &quot;A2A&quot; below refers to the Agent-to-Agent protocol.
&quot;agentId&quot;: &quot;A String&quot;, # Output only. A stable, globally unique identifier for agents.
&quot;attributes&quot;: { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {&quot;framework&quot;: &quot;google-adk&quot;} - the agent framework used to develop the Agent. Example values: &quot;google-adk&quot;, &quot;langchain&quot;, &quot;custom&quot;. * `agentregistry.googleapis.com/system/RuntimeIdentity`: {&quot;principal&quot;: &quot;principal://...&quot;} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {&quot;uri&quot;: &quot;//...&quot;} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;card&quot;: { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
&quot;content&quot;: { # Output only. The content of the agent card.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of agent card.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the agent, often obtained from the A2A Agent Card.
&quot;location&quot;: &quot;A String&quot;, # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
&quot;protocols&quot;: [ # Output only. The connection details for the Agent.
{ # Represents the protocol of an Agent.
&quot;interfaces&quot;: [ # Output only. The connection details for the Agent.
{ # Represents the connection details for an Agent or MCP Server.
&quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding of the interface.
&quot;url&quot;: &quot;A String&quot;, # Required. The destination URL.
},
],
&quot;protocolVersion&quot;: &quot;A String&quot;, # Output only. The version of the protocol, for example, the A2A Agent Card version.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the protocol.
},
],
&quot;skills&quot;: [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
{ # Represents the skills of an Agent.
&quot;description&quot;: &quot;A String&quot;, # Output only. A more detailed description of the skill.
&quot;examples&quot;: [ # Output only. Example prompts or scenarios this skill can handle.
&quot;A String&quot;,
],
&quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for the agent&#x27;s skill.
&quot;name&quot;: &quot;A String&quot;, # Output only. A human-readable name for the agent&#x27;s skill.
&quot;tags&quot;: [ # Output only. Keywords describing the skill.
&quot;A String&quot;,
],
},
],
&quot;uid&quot;: &quot;A String&quot;, # Output only. A universally unique identifier for the Agent.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time.
&quot;version&quot;: &quot;A String&quot;, # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>