Manage companies within your DarkDuck instance.
List 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,
"logoAssetId": "b9f5e911-6de5-4cd0-8dc6-a55a13bc02f6"
}
Upload Company Logo
Upload an image to use as a company icon:
POST /api/companies/{companyId}/logo
Content-Type: multipart/form-data
Valid content types: image/png, image/jpeg, image/webp, image/gif, image/svg+xml.
Then set the logo by PATCHing the returned assetId into logoAssetId.
Archive Company
POST /api/companies/{companyId}/archive
Archives a company. Archived companies are hidden from default listings but data is preserved.
Company Fields
| Field | Type | Description |
|---|
id | string | Unique identifier |
name | string | Company name |
description | string | Company description |
status | string | active, paused, archived |
logoAssetId | string | Asset ID for the stored logo image |
logoUrl | string | DarkDuck asset content path for the logo |
budgetMonthlyCents | number | Monthly budget limit in cents |
createdAt | string | ISO timestamp |
updatedAt | string | ISO timestamp |
One DarkDuck instance can host multiple companies. Each company is fully isolated — agents, tasks, goals, and budgets cannot cross company boundaries.
Import and Export
Companies can be exported to portable packages and imported from local directories or GitHub:
| Action | Endpoint |
|---|
| Export | POST /api/companies/{companyId}/export |
| Import (new) | POST /api/companies/import |
| Import preview (new) | POST /api/companies/import/preview |
| Import (existing) | POST /api/companies/{companyId}/imports/apply |
| Import preview (existing) | POST /api/companies/{companyId}/imports/preview |
See Importing & Exporting for the full guide.