Restore a revision

POST

https://api.smallest.ai/atoms/v1/agent/:id/branches/:branchId/revisions/:revisionId/restore

POST

/atoms/v1/agent/:id/branches/:branchId/revisions/:revisionId/restore

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/revisions/revisionId/restore"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.post(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "state": "scanning",
5     "revision": {
6       "_id": "64b8f9a2e4b0c123456789ab",
7       "agent": "64b8f9a2e4b0c123456789ac",
8       "status": "published",
9       "branch": "64b8f9a2e4b0c123456789ad",
10       "revisionNumber": 42,
11       "versionNumber": null,
12       "label": "Restore of v1.3.7",
13       "description": "Restored revision from previous stable release",
14       "isPinned": false,
15       "publishedBy": "user_987654321",
16       "publishedAt": "2024-01-15T09:30:00Z",
17       "publishedByName": "Jane Doe",
18       "restoredFromLabel": "v1.3.7",
19       "draftId": null,
20       "draftName": null,
21       "draftRevision": null,
22       "sourceVersionId": "64b8f9a2e4b0c123456789ae",
23       "blocks": {
24         "workflow_prompt": "64b8f9a2e4b0c123456789af",
25         "workflow_tools": "64b8f9a2e4b0c123456789b0",
26         "workflow_graph": "64b8f9a2e4b0c123456789b1",
27         "llm": "64b8f9a2e4b0c123456789b2",
28         "voice": "64b8f9a2e4b0c123456789b3",
29         "language": "64b8f9a2e4b0c123456789b4",
30         "call_handling": "64b8f9a2e4b0c123456789b5",
31         "detection": "64b8f9a2e4b0c123456789b6",
32         "analytics": "64b8f9a2e4b0c123456789b7",
33         "timeouts": "64b8f9a2e4b0c123456789b8",
34         "audio": "64b8f9a2e4b0c123456789b9",
35         "privacy": "64b8f9a2e4b0c123456789ba",
36         "widget": "64b8f9a2e4b0c123456789bb",
37         "playbooks": "64b8f9a2e4b0c123456789bc"
38       },
39       "workflowType": "standard",
40       "parentVersion": "64b8f9a2e4b0c123456789bd",
41       "isActive": true,
42       "activatedBy": "user_987654321",
43       "activatedAt": "2024-01-15T09:30:00Z",
44       "securityCheck": {
45         "status": "pending",
46         "reason": "Awaiting full scan completion",
47         "triggeredAt": "2024-01-15T09:30:00Z",
48         "completedAt": null
49       },
50       "pendingPublish": {
51         "state": "active",
52         "startedBy": "user_987654321",
53         "startedAt": "2024-01-15T09:30:00Z"
54       },
55       "restoredFromRevisionId": "64b8f9a2e4b0c123456789ae",
56       "sourceDraftId": null,
57       "promptScore": {
58         "overall_score": 87.5,
59         "overall_grade": "B+",
60         "band": "high",
61         "estimated_ttft_overhead_ms": 120.5,
62         "scoredAt": "2024-01-15T09:30:00Z",
63         "dimensions": [
64           {
65             "tier": 2,
66             "level": "moderate",
67             "evidence_span": "workflow_prompt",
68             "title": "Prompt Clarity",
69             "description": "The prompt is clear but could be more concise."
70           }
71         ]
72       },
73       "promptScoreStale": false,
74       "createdBy": "user_987654321",
75       "createdAt": "2024-01-15T09:00:00Z",
76       "updatedAt": "2024-01-15T09:30:00Z"
77     }
78   }
79 }

Republish an older revision as a new revision at the head of this branch. Restore does not overwrite history; the older revision keeps its ID, and a new revision is committed on top.

The response mirrors POST /agent/{id}/branches/{branchId}/draft/publish: 200 committed if the scan is synchronous, 202 scanning if deferred. Only one publish or restore can be in flight per branch at a time.

Republish an older revision as a new revision at the head of this branch. Restore does not overwrite history; the older revision keeps its ID, and a new revision is committed on top. The response mirrors `POST /agent/{id}/branches/{branchId}/draft/publish`: `200 committed` if the scan is synchronous, `202 scanning` if deferred. Only one publish or restore can be in flight per branch at a time.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequiredformat: "^[a-f\d]{24}$"

The agent ID.

branchIdstringRequiredformat: "^[a-f\d]{24}$"

The branch ID.

revisionIdstringRequiredformat: "^[a-f\d]{24}$"

The revision ID. Equal to the v1 versionId for revisions that were migrated from the v1 model.

Response

Restored synchronously.

statusboolean

dataobject

Result of publish or restore.

state: "committed" (HTTP 200) is returned when the commit is synchronous. This happens for restore (the source revision has already been scanned) and for publishes whose content does not need a fresh scan. The response includes the new revision object under revision.
state: "scanning" (HTTP 202) is returned when a security scan is deferred. In this case the response body carries only state. revision is absent, and clients must list the branch’s revisions newest-first (GET /agent/{id}/branches/{branchId}/revisions?limit=1) to obtain the new revision ID. Then poll GET /agent/{id}/branches/{branchId}/revisions/{revisionId} until revision.status flips from any transient value to "published". On the revision doc the lifecycle field is status (not state), and the security-scan sub-lifecycle is on the nested securityCheck.status.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

423

Locked Error

500

Internal Server Error