ActorAgentSheet actor.agent-sheet@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/actor/agent-sheet.v1.json

actor.agent-sheet@1: one owner-scoped read of an Actor agent's current work, history, approvals, computer, schedules and memory. GET /api/v1/me/agents/:id?view=sheet; never cache this answer.

Fields

FieldTypeRequiredDescriptionConstraints
agentobjectyes
agent.idstringyes
  • pattern ^agt_[0-9A-HJKMNP-TV-Z]{26}$
agent.namestringyes
agent.facestring | nullyes
agent.stateenumyes
  • one of "working", "idle", "paused"
agent.instructionsstringyes
agent.voicestring | nullyes
nowone ofyes
workhttps://openvibe.network/contracts/actor/agent-sheet.v1.json#/$defs/workyes
asksarray of objectyes
asks[].idstringyes
asks[].statestringyes
asks[].whatstringyes
asks[].whystring | null
asks[].touchstring | object | null
asks_emptystring | nullyes
computerone ofyes
schedulesarray of objectyes
schedules[].next_run_atstring | null
schedules[].last_run_atstring | null
schedules[].last_resultstring | null
memoryarray of objectyes
memory[].idstringyes
memory[].textstringyes
memory[].sourcestring
activityarray of objectyes

Examples

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

Valid: idle
{
  "agent": {
    "id": "agt_00000000000000000000000000",
    "name": "Helper",
    "face": null,
    "state": "idle",
    "instructions": "Help with alerts",
    "voice": null
  },
  "now": null,
  "work": [],
  "asks": [],
  "asks_empty": "Requests to approve or decline will appear here.",
  "computer": null,
  "schedules": [
    {
      "schedule": "off",
      "next_run_at": null,
      "last_run_at": null,
      "last_result": null
    }
  ],
  "memory": [],
  "activity": []
}
Rejected: missing-agent
{
  "now": null,
  "work": [],
  "asks": [],
  "asks_empty": null,
  "computer": null,
  "schedules": [],
  "memory": [],
  "activity": []
}

Validate

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