Skip to main content

AgentMutations

No description

type AgentMutations {
  createAgent(
    name: String!
    description: String!
  ): AgentData
  updateAgent(
    agentId: Long!
    name: String!
    description: String!
    monthlyTokenBudget: Long
    budgetNotifyUserIds: [Long!]
    budgetNotifyEmails: String
  ): Agent
  updateAgentDraft(
    agentId: Long!
    systemPrompt: String!
    integrationId: Long
    model: String!
    settings: String!
  ): AgentData
  releaseAgent(
    agentId: Long!
  ): AgentData
  setAgentPaused(
    agentId: Long!
    paused: Boolean!
  ): Agent
  deleteAgent(
    agentId: Long!
  ): Boolean
  setOrgAgentBudget(
    monthlyTokenBudget: Long
  ): Boolean
  startTestChatTurn(
    agentId: Long!
    content: String!
  ): TestChatTurn
  respondToAgentToolCall(
    agentRunId: Long!
    toolCallId: String!
    approved: Boolean!
    message: String
    editedArgs: String
  ): Boolean
  cancelAgentRun(
    agentRunId: Long!
  ): Boolean
  resetTestSession(
    agentId: Long!
  ): Boolean
  generateAgentExternalKey(
    agentId: Long!
  ): String
  revokeAgentExternalKey(
    agentId: Long!
  ): Boolean
}

Fields​

AgentMutations.createAgent ● AgentData object​

Create an agent with an empty draft version

AgentMutations.createAgent.name ● String! non-null scalar​
AgentMutations.createAgent.description ● String! non-null scalar​

AgentMutations.updateAgent ● Agent object​

Update agent identity and monthly token budget

AgentMutations.updateAgent.agentId ● Long! non-null scalar​
AgentMutations.updateAgent.name ● String! non-null scalar​
AgentMutations.updateAgent.description ● String! non-null scalar​
AgentMutations.updateAgent.monthlyTokenBudget ● Long scalar​
AgentMutations.updateAgent.budgetNotifyUserIds ● [Long!] list scalar​
AgentMutations.updateAgent.budgetNotifyEmails ● String scalar​

AgentMutations.updateAgentDraft ● AgentData object​

Update the agent's draft version (prompt, connection, model, settings)

AgentMutations.updateAgentDraft.agentId ● Long! non-null scalar​
AgentMutations.updateAgentDraft.systemPrompt ● String! non-null scalar​
AgentMutations.updateAgentDraft.integrationId ● Long scalar​
AgentMutations.updateAgentDraft.model ● String! non-null scalar​
AgentMutations.updateAgentDraft.settings ● String! non-null scalar​

AgentSettings JSON (tool refs, brakes, structured output)

AgentMutations.releaseAgent ● AgentData object​

Stamp the draft as the next release and clone a fresh draft. Also requires canManageReleases.

AgentMutations.releaseAgent.agentId ● Long! non-null scalar​

AgentMutations.setAgentPaused ● Agent object​

Pause/unpause an agent (paused agents refuse runs)

AgentMutations.setAgentPaused.agentId ● Long! non-null scalar​
AgentMutations.setAgentPaused.paused ● Boolean! non-null scalar​

AgentMutations.deleteAgent ● Boolean scalar​

Delete an agent, its versions, sessions and run history

AgentMutations.deleteAgent.agentId ● Long! non-null scalar​

AgentMutations.setOrgAgentBudget ● Boolean scalar​

Set the org-wide monthly token budget across all agents (None = unlimited)

AgentMutations.setOrgAgentBudget.monthlyTokenBudget ● Long scalar​

AgentMutations.startTestChatTurn ● TestChatTurn object​

Send a test-chat message: runs the DRAFT version (streams via watchAgentRun)

AgentMutations.startTestChatTurn.agentId ● Long! non-null scalar​
AgentMutations.startTestChatTurn.content ● String! non-null scalar​

AgentMutations.respondToAgentToolCall ● Boolean scalar​

Approve / reject-with-message / edit-args-then-approve a pending tool call

AgentMutations.respondToAgentToolCall.agentRunId ● Long! non-null scalar​
AgentMutations.respondToAgentToolCall.toolCallId ● String! non-null scalar​
AgentMutations.respondToAgentToolCall.approved ● Boolean! non-null scalar​
AgentMutations.respondToAgentToolCall.message ● String scalar​

Shown to the model on rejection so it adapts

AgentMutations.respondToAgentToolCall.editedArgs ● String scalar​

Edited arguments JSON (edit-args-then-approve)

AgentMutations.cancelAgentRun ● Boolean scalar​

Stop an in-flight agent run

AgentMutations.cancelAgentRun.agentRunId ● Long! non-null scalar​

AgentMutations.resetTestSession ● Boolean scalar​

Close the caller's test session; the next turn starts fresh

AgentMutations.resetTestSession.agentId ● Long! non-null scalar​

AgentMutations.generateAgentExternalKey ● String scalar​

Generate or rotate the agent's external API key (the credential for its per-agent MCP endpoint). Returns the plaintext key ONCE; rotating invalidates the previous key immediately. Requires a released version.

AgentMutations.generateAgentExternalKey.agentId ● Long! non-null scalar​

AgentMutations.revokeAgentExternalKey ● Boolean scalar​

Clear the agent's external API key: the endpoint 401s every request until a new key is generated

AgentMutations.revokeAgentExternalKey.agentId ● Long! non-null scalar​

Returned By​

agents mutation