ActorTaskCreateRequest actor.task-create-request@1

Generated at 2026-10-10 05:46:03 UTC from openvibe-contracts v0.127.0 and openvibe-sdk v0.37.0.

Version

1.0.0

Owner

actor

Visibility

public

Status

active

Compatibility

backward

Decision

ADR-044

Schema

https://openvibe.network/contracts/actor/task-create-request.v1.json

actor.task-create-request@1: the body of POST /api/v1/tasks on OpenVibe.Actor (capability actor.task.create), the creation subset of platform.task@1. TASK is the instruction in plain words. MODE is the planner objective (default balanced). BUDGET caps what this task may cost (per_task_usd) and what the caller's tasks may cost in one UTC day (per_day_usd); either may be left out for the person's free-allowance defaults, and a value above the person's tier is refused 422 actor.budget.over_tier, never silently lowered. AGENT pins one agent system by its id from GET /api/v1/agents (routing still checks that it can take the task). IDEMPOTENCY_KEY: a repeat from the same requester within 24 h with an identical body answers the first task (200), with a different body 409 actor.idempotency.conflict.

Fields

Examples

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

{
  "task": "Research five competitors of my shop and write a one-page brief with sources.",
  "mode": "best",
  "budget": {
    "per_task_usd": 0.5,
    "per_day_usd": 2
  },
  "agent": "openai-agent",
  "idempotency_key": "brief-2026-10-08"
}

{
  "task": "What is the TTL of openvibe.network's MX record?"
}

{
  "task": "   "
}

{
  "task": "x",
  "budget": {
    "per_task_usd": -1
  }
}

{
  "task": "x",
  "mode": "smartest"
}

{
  "task": "x",
  "webhooks": []
}

Validate

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