Publish draft

POST

https://api.smallest.ai/atoms/v1/agent/:id/branches/:branchId/draft/publish

POST

/atoms/v1/agent/:id/branches/:branchId/draft/publish

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/draft/publish"
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": "642f1b2e9a1c4d3f8b7e9a12",
7       "agent": "642f1a9e9a1c4d3f8b7e9a0f",
8       "status": "published",
9       "branch": "642f1b0a9a1c4d3f8b7e9a10",
10       "revisionNumber": 42,
11       "versionNumber": 7,
12       "label": "Release 1.3.0",
13       "description": "Published new features and bug fixes",
14       "isPinned": false,
15       "publishedBy": "user_987654321",
16       "publishedAt": "2024-01-15T09:30:00Z",
17       "publishedByName": "Jane Doe",
18       "restoredFromLabel": "Release 1.2.5",
19       "draftId": "draft_123456789",
20       "draftName": "Feature update draft",
21       "draftRevision": 3,
22       "sourceVersionId": "642f1a9e9a1c4d3f8b7e9a0e",
23       "blocks": {
24         "workflow_prompt": "642f1c3e9a1c4d3f8b7e9a20",
25         "workflow_tools": "642f1c4a9a1c4d3f8b7e9a21",
26         "workflow_graph": "642f1c559a1c4d3f8b7e9a22",
27         "llm": "642f1c609a1c4d3f8b7e9a23",
28         "voice": "642f1c6b9a1c4d3f8b7e9a24",
29         "language": "642f1c749a1c4d3f8b7e9a25",
30         "call_handling": "642f1c7f9a1c4d3f8b7e9a26",
31         "detection": "642f1c8a9a1c4d3f8b7e9a27",
32         "analytics": "642f1c949a1c4d3f8b7e9a28",
33         "timeouts": "642f1c9f9a1c4d3f8b7e9a29",
34         "audio": "642f1ca99a1c4d3f8b7e9a2a",
35         "privacy": "642f1cb49a1c4d3f8b7e9a2b",
36         "widget": "642f1cbf9a1c4d3f8b7e9a2c",
37         "playbooks": "642f1cca9a1c4d3f8b7e9a2d"
38       },
39       "workflowType": "standard",
40       "parentVersion": "642f1a9e9a1c4d3f8b7e9a0d",
41       "isActive": true,
42       "activatedBy": "user_987654321",
43       "activatedAt": "2024-01-15T09:30:00Z",
44       "securityCheck": {
45         "status": "pending",
46         "reason": "Awaiting 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": "642f1a9e9a1c4d3f8b7e9a0c",
56       "sourceDraftId": "draft_123456788",
57       "promptScore": {
58         "overall_score": 92.5,
59         "overall_grade": "A-",
60         "band": "high",
61         "estimated_ttft_overhead_ms": 120.5,
62         "scoredAt": "2024-01-15T09:30:00Z",
63         "dimensions": [
64           {
65             "tier": 1,
66             "level": "high",
67             "evidence_span": "Prompt matches training data well",
68             "title": "Relevance",
69             "description": "The prompt is highly relevant to the intended task."
70           }
71         ]
72       },
73       "promptScoreStale": false,
74       "createdBy": "user_987654321",
75       "createdAt": "2024-01-10T08:00:00Z",
76       "updatedAt": "2024-01-15T09:30:00Z"
77     }
78   }
79 }

Publish the open draft on this branch as a new revision.

The response is 200 with state: "committed" when the security scan finishes synchronously, and 202 with state: "scanning" when the scan is deferred. A scanning revision is visible in history but cannot be restored or made live until it becomes committed. If the scan fails, the revision is left in scanning state and this endpoint returns 409 on subsequent publishes until the scan is retried.

Publishing on the live branch pushes to production immediately.

Publish the open draft on this branch as a new revision. The response is `200` with `state: "committed"` when the security scan finishes synchronously, and `202` with `state: "scanning"` when the scan is deferred. A `scanning` revision is visible in history but cannot be restored or made live until it becomes `committed`. If the scan fails, the revision is left in `scanning` state and this endpoint returns `409` on subsequent publishes until the scan is retried. Publishing on the live branch pushes to production immediately.

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.

Request

This endpoint expects an object.

labelstring or nullOptional<=200 characters

Optional label saved on the committed revision.

Response

Draft committed 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