Create a branch

POST

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

POST

/atoms/v1/agent/:id/branches

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

1 {
2   "status": true,
3   "data": {
4     "_id": "5f8d0d55b54764421b7156c4",
5     "agent": "5f8d0d55b54764421b7156b9",
6     "name": "feature/user-authentication",
7     "isDefault": false,
8     "sourceBranchId": "5f8d0d55b54764421b7156c3",
9     "sourceRevisionId": "rev_20240610a1b2c3d4e5f6",
10     "headRevisionId": "rev_20240612f6e5d4c3b2a1",
11     "openDraftId": "draft_20240613a1b2c3d4e5f6",
12     "status": "active",
13     "createdBy": "user_12345",
14     "updatedBy": "user_12345",
15     "createdAt": "2024-01-15T09:30:00Z",
16     "updatedAt": "2024-01-15T09:30:00Z"
17   }
18 }

Fork a new branch from an existing branch. The source branch must have at least one committed revision. Branch names are unique per agent; the name Main is reserved for the default branch. Creating from a branch whose latest draft is still scanning returns 409 source_scanning.

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.

Request

This endpoint expects an object.

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

Branch to fork from. Its head revision must exist.

namestringRequired1-100 characters

New branch name. Unique per agent among active branches. main is reserved.

Response

Branch created.

statusboolean

dataobject

An AgentBranch document. An editable copy of an agent with its own draft slot and revision chain.

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