paperclip/docs/api/approvals.md at f4803291b847ce79f21029644a6c3821d78b15b4

Files

Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding

- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-03 15:49:43 -06:00

1.8 KiB

Raw Blame History

title, summary

title	summary
Approvals	Approval workflow endpoints

Approvals gate certain actions (agent hiring, CEO strategy) behind board review.

List Approvals

GET /api/companies/{companyId}/approvals

Query parameters:

Param	Description
`status`	Filter by status (e.g. `pending`)

Get Approval

GET /api/approvals/{approvalId}

Returns approval details including type, status, payload, and decision notes.

Create Approval Request

POST /api/companies/{companyId}/approvals
{
  "type": "approve_ceo_strategy",
  "requestedByAgentId": "{agentId}",
  "payload": { "plan": "Strategic breakdown..." }
}

Create Hire Request

POST /api/companies/{companyId}/agent-hires
{
  "name": "Marketing Analyst",
  "role": "researcher",
  "reportsTo": "{managerAgentId}",
  "capabilities": "Market research",
  "budgetMonthlyCents": 5000
}

Creates a draft agent and a linked hire_agent approval.

Approve

POST /api/approvals/{approvalId}/approve
{ "decisionNote": "Approved. Good hire." }

Reject

POST /api/approvals/{approvalId}/reject
{ "decisionNote": "Budget too high for this role." }

Request Revision

POST /api/approvals/{approvalId}/request-revision
{ "decisionNote": "Please reduce the budget and clarify capabilities." }

Resubmit

POST /api/approvals/{approvalId}/resubmit
{ "payload": { "updated": "config..." } }

Linked Issues

GET /api/approvals/{approvalId}/issues

Returns issues linked to this approval.

Approval Comments

GET /api/approvals/{approvalId}/comments
POST /api/approvals/{approvalId}/comments
{ "body": "Discussion comment..." }

Approval Lifecycle

pending -> approved
        -> rejected
        -> revision_requested -> resubmitted -> pending

1.8 KiB Raw Blame History