Make a branch live

POST

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

POST

/atoms/v1/agent/:id/branches/:branchId/live

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/live"
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     "branch": {
5       "_id": "64b8f9a2e4b0c123456789ab",
6       "agent": "64b8f9a2e4b0c123456789cd",
7       "name": "feature/new-intent-handling",
8       "isDefault": false,
9       "sourceBranchId": "64b8f9a2e4b0c123456789aa",
10       "sourceRevisionId": "rev_20240612_01",
11       "headRevisionId": "rev_20240615_05",
12       "openDraftId": null,
13       "status": "active",
14       "createdBy": "user_987654321",
15       "updatedBy": "user_987654321",
16       "createdAt": "2024-01-15T09:30:00Z",
17       "updatedAt": "2024-06-10T14:45:00Z"
18     },
19     "isLive": true,
20     "hasOpenDraft": false,
21     "revisionsCount": 12,
22     "headRevisionNumber": 12
23   }
24 }

Make this branch the live branch. Its headRevisionId becomes the config that serves production traffic. The previously-live branch becomes not-live automatically. The branch must be non-archived, must have at least one committed (security-passed) revision, and its head revision must have passed the security scan.

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.

Response

Branch is now live.

statusboolean

dataobject

Branch document plus derived fields used by list and detail views.

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