02dc46e782
Add structured documentation covering quickstart, architecture, core concepts, API reference, adapter guides, CLI commands, deployment options, and operator/developer guides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
66 lines
1.2 KiB
Markdown
66 lines
1.2 KiB
Markdown
---
|
|
title: Companies
|
|
summary: Company CRUD endpoints
|
|
---
|
|
|
|
# Companies API
|
|
|
|
Manage companies within your Paperclip instance.
|
|
|
|
## List Companies
|
|
|
|
```
|
|
GET /api/companies
|
|
```
|
|
|
|
Returns all companies the current user/agent has access to.
|
|
|
|
## Get Company
|
|
|
|
```
|
|
GET /api/companies/{companyId}
|
|
```
|
|
|
|
Returns company details including name, description, budget, and status.
|
|
|
|
## Create Company
|
|
|
|
```
|
|
POST /api/companies
|
|
{
|
|
"name": "My AI Company",
|
|
"description": "An autonomous marketing agency"
|
|
}
|
|
```
|
|
|
|
## Update Company
|
|
|
|
```
|
|
PATCH /api/companies/{companyId}
|
|
{
|
|
"name": "Updated Name",
|
|
"description": "Updated description",
|
|
"budgetMonthlyCents": 100000
|
|
}
|
|
```
|
|
|
|
## Archive Company
|
|
|
|
```
|
|
POST /api/companies/{companyId}/archive
|
|
```
|
|
|
|
Archives a company. Archived companies are hidden from default listings.
|
|
|
|
## Company Fields
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `id` | string | Unique identifier |
|
|
| `name` | string | Company name |
|
|
| `description` | string | Company description |
|
|
| `status` | string | `active`, `paused`, `archived` |
|
|
| `budgetMonthlyCents` | number | Monthly budget limit |
|
|
| `createdAt` | string | ISO timestamp |
|
|
| `updatedAt` | string | ISO timestamp |
|