AgentRun agent.run@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
actor
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/agent/run.v1.json

agent.run@1 snapshot of a run and its current plan, steps, sources, result, timestamps and cost.

Fields

FieldTypeRequiredDescriptionConstraints
idstringyes
  • minLength 1
  • maxLength 160
productstringyes
  • minLength 1
  • maxLength 40
titlestringyes
  • minLength 1
  • maxLength 240
statusenumyes
  • one of "queued", "running", "waiting", "needs_you", "succeeded", "failed", "stopped", "cancelled"
planarray of objectyes
  • items: no other fields
plan[].titlestringyes
  • minLength 1
  • maxLength 240
plan[].statusenumyes
  • one of "todo", "running", "waiting", "needs_you", "done", "failed", "stopped"
stepshttps://openvibe.network/contracts/agent/run.v1.json#/$defs/stepyes
sourceshttps://openvibe.network/contracts/agent/run.v1.json#/$defs/sourceyes
resultobject | nullyes
started_atstringyes
  • format date-time
ended_atstring | nullyes
  • format date-time
cost_usdnumber | nullyes
  • minimum 0

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: example
{
  "id": "run_1",
  "product": "codes",
  "title": "Review repositories",
  "status": "running",
  "plan": [
    {
      "title": "Read repositories",
      "status": "running"
    }
  ],
  "steps": [],
  "sources": [],
  "result": null,
  "started_at": "2026-11-11T00:00:00Z",
  "ended_at": null,
  "cost_usd": null
}
Rejected: example
{
  "id": "run_1",
  "product": "codes",
  "title": "Review",
  "status": "unknown",
  "plan": [],
  "steps": [],
  "sources": [],
  "result": null,
  "started_at": "bad",
  "ended_at": null,
  "cost_usd": -1
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('agent.run@1', value);   // { valid, errors: [{ path, message }] }