POST to https://app.arize.com/graphql with an x-api-key header; see Forming calls.
Mutations in this page
createSandboxIntegration: Create sandbox integration.updateSandboxIntegration: Update sandbox integration.deleteSandboxIntegration: Delete sandbox integration.createSandboxConfig: Create sandbox config.updateSandboxConfig: Update sandbox config.deleteSandboxConfig: Delete sandbox config.addIntegrationToSandboxConfig: Add integration to sandbox config.createSandboxJob: Create a new managed agent sandbox jobcreateSandboxTemplate: Snapshot a sandbox and save it as a reusable template for future jobssendSandboxMessage: Send a follow-up message to a running sandbox agentcreateAutomation: Create a new managed agent automation.updateAutomation: Replace an existing automation’s trigger (cron cadence or metric config) in full and set or clear its per-automation agent-runtime override, in a single save.deleteAutomation: Soft-delete a managed agent automation.setAutomationEnabled: Pause or resume a managed agent automation.setAutomationRepo: Set or clear an automation’s repo binding — the repo its spawned jobs and ‘Open PR’ / ‘Open GitHub issue’ actions target.triggerAutomationNow: Spawn a job for an automation immediately, bypassing next_fire_at.setSignalEnabled: Enable or disable the Signal automation for a project.setSignalEnabledBulk: Enable or disable the Signal automation for multiple projects in one call.updateSignalConfig: Update a project’s Signal config: the run cadence and the free-form additional context injected into the Signal prompt.setSignalAgentConfig: Attach a custom agent config (sandbox config) to a project’s Signal automation, repointing it away from the shared built-in default.resetSignalAgentConfig: Revert a project’s Signal automation back to the shared built-in agent config, detaching any custom config (the custom config itself is left intact).setSignalIssueStatus: Set the lifecycle status of a Signal issue — Resolve, Ignore, or re-open it.openSignalIssuePR: Launch a managed agent sandbox job that fixes a Signal issue and opens a PR, borrowing the project’s Signal automation repo/agent config.openSignalIssueGitHubIssue: File a GitHub issue for a Signal issue, using the project’s Signal repo and its connected GitHub token.deleteSignal: Delete the Signal automation for a project.
Reference
createSandboxIntegration
createSandboxIntegration(input: CreateSandboxIntegrationInput!): CreateSandboxIntegrationPayload
Arguments
CreateSandboxIntegrationInput!
required
Returns
SandboxIntegration!
The created sandbox integration
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
updateSandboxIntegration
updateSandboxIntegration(input: UpdateSandboxIntegrationInput!): UpdateSandboxIntegrationPayload
Arguments
UpdateSandboxIntegrationInput!
required
Returns
SandboxIntegration!
The updated sandbox integration
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
deleteSandboxIntegration
deleteSandboxIntegration(input: DeleteSandboxIntegrationInput!): DeleteSandboxIntegrationPayload
Arguments
DeleteSandboxIntegrationInput!
required
Returns
Boolean!
Whether the integration was successfully soft-deleted
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
createSandboxConfig
createSandboxConfig(input: CreateSandboxConfigInput!): CreateSandboxConfigPayload
Arguments
CreateSandboxConfigInput!
required
Returns
SandboxConfig!
The created sandbox config
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
updateSandboxConfig
updateSandboxConfig(input: UpdateSandboxConfigInput!): UpdateSandboxConfigPayload
Arguments
UpdateSandboxConfigInput!
required
Returns
SandboxConfig!
The updated sandbox config
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
deleteSandboxConfig
deleteSandboxConfig(input: DeleteSandboxConfigInput!): DeleteSandboxConfigPayload
Arguments
DeleteSandboxConfigInput!
required
Returns
Int!
How many configs were actually soft-deleted. May be less than the requested count if some ids did not exist, belonged to another account, or were already deleted.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
addIntegrationToSandboxConfig
addIntegrationToSandboxConfig(input: AddIntegrationToSandboxConfigInput!): AddIntegrationToSandboxConfigPayload
Arguments
AddIntegrationToSandboxConfigInput!
required
Returns
SandboxConfig!
The updated sandbox config
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
createSandboxJob
Create a new managed agent sandbox jobcreateSandboxJob(input: CreateSandboxJobInput!): CreateSandboxJobPayload
Arguments
CreateSandboxJobInput!
required
Returns
ID!
The Relay global ID of the newly created sandbox job
ID
The Relay global ID of the newly created sandbox, if one exists.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
createSandboxTemplate
Snapshot a sandbox and save it as a reusable template for future jobscreateSandboxTemplate(input: CreateSandboxTemplateInput!): CreateSandboxTemplatePayload
Arguments
CreateSandboxTemplateInput!
required
Returns
String!
The integer primary key of the newly created sandbox template
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
sendSandboxMessage
Send a follow-up message to a running sandbox agentsendSandboxMessage(input: SendSandboxMessageInput!): SendSandboxMessagePayload
Arguments
SendSandboxMessageInput!
required
Returns
String!
The sandbox job ID the message was sent to
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
createAutomation
Create a new managed agent automation.createAutomation(input: CreateAutomationInput!): CreateAutomationPayload
Arguments
CreateAutomationInput!
required
Returns
ID!
Relay GID of the newly created automation.
ID
Relay GID of the initial job, or null when it could not be started.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
updateAutomation
Replace an existing automation’s trigger (cron cadence or metric config) in full and set or clear its per-automation agent-runtime override, in a single save. Exactly one of cron/metric must be provided, mirroring createAutomation. Recomputes the next fire time so the new schedule takes effect on the next cycle.updateAutomation(input: UpdateAutomationInput!): UpdateAutomationPayload
Arguments
UpdateAutomationInput!
required
Returns
Boolean!
True when the update completed.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
deleteAutomation
Soft-delete a managed agent automation.deleteAutomation(input: DeleteAutomationInput!): DeleteAutomationPayload
Arguments
DeleteAutomationInput!
required
Returns
Boolean!
True when the soft-delete completed.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setAutomationEnabled
Pause or resume a managed agent automation. Disabled automations stay in the list (keeping their config) but are skipped by the scheduler.setAutomationEnabled(input: SetAutomationEnabledInput!): SetAutomationEnabledPayload
Arguments
SetAutomationEnabledInput!
required
Returns
Boolean!
True when the update completed.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setAutomationRepo
Set or clear an automation’s repo binding — the repo its spawned jobs and ‘Open PR’ / ‘Open GitHub issue’ actions target. Overrides the bound sandbox_config’s repo; an empty string clears the binding so jobs inherit the config’s repo. Used to attach or change the repo for a producer agent (e.g. Cost), which keeps its repo on the automation rather than the shared preset.setAutomationRepo(input: SetAutomationRepoInput!): SetAutomationRepoPayload
Arguments
SetAutomationRepoInput!
required
Returns
Boolean!
True when the update completed.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
triggerAutomationNow
Spawn a job for an automation immediately, bypassing next_fire_at. All admission gates (cooloff, capacity, signal-issue limit) still apply. next_fire_at is reset to now+cadence so the schedule resumes from now.triggerAutomationNow(input: TriggerAutomationNowInput!): TriggerAutomationNowPayload
Arguments
TriggerAutomationNowInput!
required
Returns
Int!
DB id of the newly created sandbox job.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setSignalEnabled
Enable or disable the Signal automation for a project. Enabling lazily provisions the built-in Signal preset; disabling pauses the scheduler but keeps the automation.setSignalEnabled(input: SetSignalEnabledInput!): SetSignalEnabledPayload
Arguments
SetSignalEnabledInput!
required
Returns
Boolean!
True when the update completed.
SignalStatus!
The Signal status after the update.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setSignalEnabledBulk
Enable or disable the Signal automation for multiple projects in one call. Each project is processed independently — a single project’s failure does not abort the others — and per-project outcomes are returned inresults.
setSignalEnabledBulk(input: SetSignalEnabledBulkInput!): SetSignalEnabledBulkPayload
Arguments
SetSignalEnabledBulkInput!
required
Returns
[SignalEnabledBulkResult!]!
The per-project outcome of the bulk update.
Int!
Number of projects that were updated successfully.
Int!
Number of projects that failed to update.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
updateSignalConfig
Update a project’s Signal config: the run cadence and the free-form additional context injected into the Signal prompt.updateSignalConfig(input: UpdateSignalConfigInput!): UpdateSignalConfigPayload
Arguments
UpdateSignalConfigInput!
required
Returns
Boolean!
True when the update completed.
SignalStatus!
The Signal status after the update.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setSignalAgentConfig
Attach a custom agent config (sandbox config) to a project’s Signal automation, repointing it away from the shared built-in default.setSignalAgentConfig(input: SetSignalAgentConfigInput!): SetSignalAgentConfigPayload
Arguments
SetSignalAgentConfigInput!
required
Returns
Boolean!
True when the update completed.
SignalStatus!
The Signal status after the update.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
resetSignalAgentConfig
Revert a project’s Signal automation back to the shared built-in agent config, detaching any custom config (the custom config itself is left intact).resetSignalAgentConfig(input: ResetSignalAgentConfigInput!): ResetSignalAgentConfigPayload
Arguments
ResetSignalAgentConfigInput!
required
Returns
Boolean!
True when the update completed.
SignalStatus!
The Signal status after the update.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
setSignalIssueStatus
Set the lifecycle status of a Signal issue — Resolve, Ignore, or re-open it. Resolving/ignoring removes it from the active dashboard view; a resolved issue silently re-opens if the problem recurs, while an ignored one stays suppressed. Gated by hasSignalIssueWriteAccess (PROJECT_UPDATE).setSignalIssueStatus(input: SetSignalIssueStatusInput!): SetSignalIssueStatusPayload
Arguments
SetSignalIssueStatusInput!
required
Returns
SignalIssue!
The Signal issue after the update, with its persisted status. Returning the node lets Relay merge the new status into its store.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
openSignalIssuePR
Launch a managed agent sandbox job that fixes a Signal issue and opens a PR, borrowing the project’s Signal automation repo/agent config. Gated by hasSignalIssueWriteAccess (PROJECT_UPDATE).openSignalIssuePR(input: OpenSignalIssuePRInput!): OpenSignalIssuePRPayload
Arguments
OpenSignalIssuePRInput!
required
Returns
ID!
Relay GID of the newly launched sandbox job.
ID
Relay GID of the sandbox provisioned for the job, if one exists yet.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
openSignalIssueGitHubIssue
File a GitHub issue for a Signal issue, using the project’s Signal repo and its connected GitHub token. Runs entirely in app-server (no sandbox agent). Gated by hasSignalIssueWriteAccess (PROJECT_UPDATE).openSignalIssueGitHubIssue(input: OpenSignalIssueGitHubIssueInput!): OpenSignalIssueGitHubIssuePayload
Arguments
OpenSignalIssueGitHubIssueInput!
required
Returns
String!
html_url of the newly created GitHub issue.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.
deleteSignal
Delete the Signal automation for a project. Idempotent — deleting an absent Signal is a no-op.deleteSignal(input: DeleteSignalInput!): DeleteSignalPayload
Arguments
DeleteSignalInput!
required
Returns
Boolean!
True when the delete completed.
Example
Only required input fields are shown. Replace<ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.