Install agent

installAgent(input: InstallProjectAgentInput!): ProjectAgentCard!

Requires project.agents.write.

Arguments

ArgumentTypeRequired
inputInstallProjectAgentInput!Yes

Input fields

input

InstallProjectAgentInput

FieldTypeRequiredDescription
projectReferenceStringNo
agentIdString!Yes
relationStringNoRelation of the agent access grant that installs the catalog agent. Installing creates or reuses an access grant; the agent is not copied.

Response

Returns ProjectAgentCard!. Open the type for its fields and nested types.

FieldType
avatarUrlString
idID!
nameString!
descriptionString
providerJSON!
versionString!
capabilitiesJSON!
defaultInputModes[String!]!

All fields of ProjectAgentCard.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation InstallAgent($input: InstallProjectAgentInput!) {
  installAgent(input: $input) {
    id
    name
    avatarUrl
    canRun
    capabilities
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "agentId": "00000000-0000-4000-8000-000000000001"
  }
}