Regenerate
ReferenceUpdated June 14, 2026
Regenerate
Rebuild the workspace's company summary and market research documents from the current workspace_details. Free (rate limited).
Because these pipelines run far longer than a normal request, regenerate starts them in the background and returns a tracking job immediately. The job is not processed by the generic worker — its status is derived from live document readiness when you poll. See Conventions → Async jobs.
Regenerate workspace documents
POST /api/v1/workspace/regenerate · scope workspace:write · (async, status derived)
Example request
curl -X POST "https://app.machfive.io/api/v1/workspace/regenerate" \
-H "Authorization: Bearer YOUR_API_KEY"Response (202 Accepted)
{
"id": "job-uuid",
"type": "workspace.regenerate",
"status": "processing",
"targets": ["company_summary", "market_research"]
}Error responses
| Status | Error | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid API key. |
| 403 | FORBIDDEN | Key missing the workspace:write scope. |
| 404 | NOT_FOUND | No workspace owner found for this API key. |
| 429 | RATE_LIMITED | Per-key rate limit exceeded (this write fails closed when the limiter is unavailable). |
| 500 | INTERNAL_ERROR | Server error. |
Poll regeneration status
GET /api/v1/workspace/regenerate/:id · scope workspace:read
{
"id": "job-uuid",
"status": "processing",
"artifacts": [
{ "type": "company_summary", "status": "ready" },
{ "type": "market_research", "status": "processing" }
]
}When both artifacts reach ready, status flips to completed.
Error responses
| Status | Error | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid API key. |
| 403 | FORBIDDEN | Key missing the required scope. |
| 404 | NOT_FOUND | Job not found in this workspace. |
| 429 | RATE_LIMITED | Per-key rate limit exceeded. |
The rebuilt documents are available via Workspace Documents with signed download URLs.