Get branch

GET

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

GET

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

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

1 {
2   "status": true,
3   "data": {
4     "branch": {
5       "_id": "5f8d0d55b54764421b7156c3",
6       "agent": "5f8d0c4eb54764421b7156b9",
7       "name": "feature/user-authentication",
8       "isDefault": false,
9       "sourceBranchId": "5f8d0d55b54764421b7156c1",
10       "sourceRevisionId": "rev-20240110-abc123",
11       "headRevisionId": "rev-20240115-def456",
12       "openDraftId": "draft-20240115-xyz789",
13       "status": "active",
14       "createdBy": "user_12345",
15       "updatedBy": "user_67890",
16       "createdAt": "2024-01-15T09:30:00Z",
17       "updatedAt": "2024-01-15T09:30:00Z"
18     },
19     "isLive": false,
20     "hasOpenDraft": true,
21     "revisionsCount": 5,
22     "headRevisionNumber": 42
23   }
24 }

Return a single branch summary, including draft state (openDraftId, hasOpenDraft) and head revision.

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

Successful response.

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

500

Internal Server Error