Requirements

Manage requirements. Use action=“create” to create a new requirement (requires title). Use action=“update” to update an existing requirement (requires requirement_id). Use action=“list” to get requirements with filters.

Input Schema

Parameter	Type	Description
action	string	Action to perform on requirements. Enum: create, list, update
requirement_id	string	Requirement UUID (required for update)
title	string	Requirement title (required for create)
description	string	Detailed description
instructions	string	Implementation instructions
priority	string	Priority of the requirement. Valid values: high, medium, low. Default: medium. Enum: high, medium, low
status	string	Status of the requirement. Valid values: backlog, validated, in-progress, on-review, done, canceled. Default: backlog. Enum: backlog, validated, in-progress, on-review, done, canceled
completion_status	string	Completion status of the requirement. Valid values: pending, completed, rejected. Enum: pending, completed, rejected
type	string	Type of requirement (e.g., content, design, task, develop, analytics, etc.). Default: task
budget	number	Budget amount (numeric)
cron	string	Text to manage how often it should repeat
cycle	string	Specify the source of the work cycle. Set this to ensure an entire development cycle is performed for the requirement (can be null or a new numeric or text value)
campaign_id	string	Campaign UUID to link requirement
metadata	object	Additional metadata (json object)
site_id	string	Filter by site UUID
user_id	string	Filter by user UUID
search	string	Text search in title/description
sort_by	string	Field to sort by
sort_order	string	Sort order. Enum: asc, desc
limit	number	Max results (default 50)
offset	number	Pagination offset

REST Endpoint

Actions map to sub-routes: create → /create, list → /get, update → /update.


POST /api/agents/tools/requirements/create
POST /api/agents/tools/requirements/get
POST /api/agents/tools/requirements/update


POST /api/agents/tools/requirements/create
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
 
{
  "site_id": "YOUR_SITE_ID",
  "title": "Build lead scoring model",
  "priority": "high",
  "status": "backlog",
  "type": "develop",
  "cron": "every monday",
  "cycle": "Sprint 4"
}

Response:


{
  "success": true,
  "requirement": { "id": "...", "title": "Build lead scoring model", "cron": "every monday", "cycle": "Sprint 4" }
}