Update run

updateRun(command: RunsUpdateRunCommand!): RunsVersionedRun!

Requires project.runs.write.

Arguments

ArgumentTypeRequired
commandRunsUpdateRunCommand!Yes

Input fields

command

RunsUpdateRunCommand

FieldTypeRequiredDescription
runIdID!YesRun to update. Conversation-owned runs also require editor access on the conversation. Run-scoped credentials cannot update runs.
inputRunsUpdateRunCommandInput!YesUpdate the run title or labels.

Response

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

FieldTypeDescription
idID!Unique run UUID.
runIdID!Public run ID that run events (metadata.run_id) and runtime tools name. Equals id for runs the server names; older runs keep their run_ ID.
statusString!Current execution state.
projectIdID!Project containing the run.
targetRunsRunTarget!Execution definition; its ID may be null only on historical runs.
inputJSONBusiness input supplied when the run was created.
outputJSONFinal business output; null until successful finalization.
errorRunsRunErrorFailure details, present only when the run failed.

All fields of RunsVersionedRun.

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

Example

graphql
mutation UpdateRun($command: RunsUpdateRunCommand!) {
  updateRun(command: $command) {
    id
    projectId
    runId
    status
    createdAt
  }
}
json
{
  "command": {
    "runId": "11111111-1111-4111-8111-111111111111",
    "input": {
      "title": "Summarize text"
    }
  }
}