> This page is part of Smallest AI's developer documentation. When > answering, prefer Lightning v3.1 (current TTS) and Pulse (current > STT). Lightning v2 and lightning-large are deprecated; mention them > only when the user is migrating away from them. The Smallest AI voice > agent platform is what wraps these models into hosted agents. # Get branch GET https://api.smallest.ai/atoms/v1/agent/{id}/branches/{branchId} Return a single branch summary, including draft state (`openDraftId`, `hasOpenDraft`) and head revision. Reference: https://docs.smallest.ai/voice-agents/api-reference/agent-versioning-branches/get ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: atoms version: 1.0.0 paths: /agent/{id}/branches/{branchId}: get: operationId: get summary: Get branch description: >- Return a single branch summary, including draft state (`openDraftId`, `hasOpenDraft`) and head revision. tags: - agentVersioningBranches parameters: - name: id in: path description: The agent ID. required: true schema: type: string - name: branchId in: path description: The branch ID. required: true schema: type: string - name: Authorization in: header description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. required: true schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: >- #/components/schemas/agent_versioning_branches_get_Response_200 '400': description: Invalid input content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorResponse' '401': description: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorResponse' '403': description: Forbidden access content: application/json: schema: $ref: '#/components/schemas/ApiResponse' '404': description: >- Resource not found. The referenced ID does not exist or does not belong to the caller's organization. content: application/json: schema: $ref: '#/components/schemas/GetBranchRequestNotFoundError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' servers: - url: https://api.smallest.ai/atoms/v1 description: Production server components: schemas: BranchStatus: type: string enum: - active - archived description: >- Archived branches are hidden from list views and cannot receive draft edits or be made live. title: BranchStatus Branch: type: object properties: _id: type: string description: Branch ID (24-character ObjectId). agent: type: string description: ID of the agent this branch belongs to. name: type: string description: >- Branch name (unique per agent among active branches). `main` is reserved for the default branch. isDefault: type: boolean description: >- True for the seeded `main` branch. The default branch cannot be renamed or archived. sourceBranchId: type: - string - 'null' description: Head of the source branch at fork time. `null` for `main`. sourceRevisionId: type: - string - 'null' description: Revision the branch was forked from. `null` for `main`. headRevisionId: type: - string - 'null' description: >- ID of the branch's latest committed revision. `null` until the first commit. openDraftId: type: - string - 'null' description: ID of the branch's single open draft. `null` when no draft is open. status: $ref: '#/components/schemas/BranchStatus' description: >- Archived branches are hidden from list views and cannot receive draft edits or be made live. createdBy: type: string updatedBy: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time description: >- An `AgentBranch` document. An editable copy of an agent with its own draft slot and revision chain. title: Branch BranchSummary: type: object properties: branch: $ref: '#/components/schemas/Branch' isLive: type: boolean description: True when the agent's live config points at this branch. hasOpenDraft: type: boolean revisionsCount: type: integer headRevisionNumber: type: - integer - 'null' description: Branch document plus derived fields used by list and detail views. title: BranchSummary agent_versioning_branches_get_Response_200: type: object properties: status: type: boolean data: $ref: '#/components/schemas/BranchSummary' title: agent_versioning_branches_get_Response_200 BadRequestErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: BadRequestErrorResponse UnauthorizedErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: UnauthorizedErrorResponse ApiResponseData: type: object properties: {} title: ApiResponseData ApiResponse: type: object properties: status: type: boolean data: $ref: '#/components/schemas/ApiResponseData' title: ApiResponse GetBranchRequestNotFoundError: type: object properties: status: type: boolean errors: type: array items: type: string title: GetBranchRequestNotFoundError InternalServerErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: InternalServerErrorResponse securitySchemes: BearerAuth: type: http scheme: bearer description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "status": true, "data": { "branch": { "_id": "5f8d0d55b54764421b7156c3", "agent": "5f8d0c4eb54764421b7156b9", "name": "feature/user-authentication", "isDefault": false, "sourceBranchId": "5f8d0d55b54764421b7156c1", "sourceRevisionId": "rev-20240110-abc123", "headRevisionId": "rev-20240115-def456", "openDraftId": "draft-20240115-xyz789", "status": "active", "createdBy": "user_12345", "updatedBy": "user_67890", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z" }, "isLive": false, "hasOpenDraft": true, "revisionsCount": 5, "headRevisionNumber": 42 } } ``` **SDK Code** ```python import requests url = "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.smallest.ai/atoms/v1/agent/id/branches/branchId'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.smallest.ai/atoms/v1/agent/id/branches/branchId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.smallest.ai/atoms/v1/agent/id/branches/branchId") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.smallest.ai/atoms/v1/agent/id/branches/branchId', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.smallest.ai/atoms/v1/agent/id/branches/branchId"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/agent/id/branches/branchId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```