Rename a branch

PATCH

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

PATCH

/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 = { "name": "feature-login-enhancement" }
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.patch(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "_id": "64b8f3a2c9e77a0012345678",
5     "agent": "64b8f2d1c9e77a0012341234",
6     "name": "feature-login-enhancement",
7     "isDefault": false,
8     "sourceBranchId": "64b8f2d1c9e77a0012341234",
9     "sourceRevisionId": "64b8f3a2c9e77a0012345677",
10     "headRevisionId": "64b8f3a2c9e77a0012345679",
11     "openDraftId": "64b8f3a2c9e77a0012345680",
12     "status": "active",
13     "createdBy": "user_987654321",
14     "updatedBy": "user_987654321",
15     "createdAt": "2024-01-15T09:30:00Z",
16     "updatedAt": "2024-01-15T09:30:00Z"
17   }
18 }

Rename a non-default, non-archived branch. Main cannot be renamed; a name that is already in use on this agent returns 409 branch_name_exists.

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.

namestringRequired1-100 characters

Response

Renamed.

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