v1_card

Creates, updates, deletes, gets or lists a v1_card resource.

Overview

Name	v1_card
Type	Resource
Id	google.discoveryengine.v1_card

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_engines_assistants_agents_a2a_v1_get_card

Name	Datatype	Description
name	string	A human readable name for the agent. Example: "Recipe Agent"
additionalInterfaces	array	Announcement of additional supported transports. Client can use any of the supported transports.
capabilities	object	A2A Capability set supported by the agent. (id: A2aV1AgentCapabilities)
defaultInputModes	array	protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.
defaultOutputModes	array	The mime types supported as outputs from this agent.
description	string	A description of the agent's domain of action/solution space. Example: "Agent that helps users with recipes and cooking."
documentationUrl	string	A url to provide additional documentation about the agent.
iconUrl	string	An optional URL to an icon for the agent.
preferredTransport	string	The transport of the preferred endpoint. If empty, defaults to JSONRPC.
protocolVersion	string	The version of the A2A protocol this agent supports.
provider	object	The service provider of the agent. (id: A2aV1AgentProvider)
security	array	protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, "callers must either use OAuth OR an API Key AND mTLS." Example: security { schemes { key: "oauth" value { list: ["read"] } } } security { schemes { key: "api-key" } schemes { key: "mtls" } }
securitySchemes	object	The security scheme details used for authenticating with this agent.
signatures	array	JSON Web Signatures computed for this AgentCard.
skills	array	Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
supportsAuthenticatedExtendedCard	boolean	Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.
url	string	A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.
version	string	The version of the agent. Example: "1.0.0"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_engines_assistants_agents_a2a_v1_get_card	select	projectsId, locationsId, collectionsId, enginesId, assistantsId, agentsId		GetAgentCard returns the agent card for the agent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
assistantsId	string
collectionsId	string
enginesId	string
locationsId	string
projectsId	string

SELECT examples

projects_locations_collections_engines_assistants_agents_a2a_v1_get_card

GetAgentCard returns the agent card for the agent.

SELECT
name,
additionalInterfaces,
capabilities,
defaultInputModes,
defaultOutputModes,
description,
documentationUrl,
iconUrl,
preferredTransport,
protocolVersion,
provider,
security,
securitySchemes,
signatures,
skills,
supportsAuthenticatedExtendedCard,
url,
version
FROM google.discoveryengine.v1_card
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND assistantsId = '{{ assistantsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
;