> 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.

# Make a branch live

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

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.


Reference: https://docs.smallest.ai/voice-agents/api-reference/agent-versioning-branches/make-live

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: atoms
  version: 1.0.0
paths:
  /agent/{id}/branches/{branchId}/live:
    post:
      operationId: make-live
      summary: Make a branch live
      description: >
        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.
      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: Branch is now live.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/agent_versioning_branches_make_live_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. Branch is archived, security scan has not passed on the
            head revision, or the caller lacks write 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/MakeBranchLiveRequestNotFoundError'
        '409':
          description: >-
            Conflict. The request cannot be completed because of the current
            state of the resource (name already exists, another publish or
            restore is in progress, the source draft failed its security scan,
            or a similar in-flight collision).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorResponse'
        '423':
          description: >-
            Locked. A configuration freeze is active on this agent, or the
            resource is temporarily locked for another write. Retry after the
            freeze window ends.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockedErrorResponse'
        '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_make_live_Response_200:
      type: object
      properties:
        status:
          type: boolean
        data:
          $ref: '#/components/schemas/BranchSummary'
      title: agent_versioning_branches_make_live_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
    MakeBranchLiveRequestNotFoundError:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: MakeBranchLiveRequestNotFoundError
    ConflictErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        error_type:
          type: string
        errors:
          type: array
          items:
            type: string
      description: >
        Generic conflict body. `error_type` is a stable machine-readable
        discriminator (for example `branch_name_exists`, `source_has_no_commit`,
        `source_scanning`, `publish_in_progress`, `no_committed_revision`).
      title: ConflictErrorResponse
    LockedErrorResponseErrorType:
      type: string
      enum:
        - config_freeze_active
      title: LockedErrorResponseErrorType
    LockedErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        error_type:
          $ref: '#/components/schemas/LockedErrorResponseErrorType'
        errors:
          type: array
          items:
            type: string
      description: >
        Config-freeze body. Returned on write endpoints during a maintenance
        window (`AGENT_CONFIG_FROZEN`). Reads and test-calls pass.
      title: LockedErrorResponse
    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": "64b8f9a2e4b0c123456789ab",
      "agent": "64b8f9a2e4b0c123456789cd",
      "name": "feature/new-intent-handling",
      "isDefault": false,
      "sourceBranchId": "64b8f9a2e4b0c123456789aa",
      "sourceRevisionId": "rev_20240612_01",
      "headRevisionId": "rev_20240615_05",
      "openDraftId": null,
      "status": "active",
      "createdBy": "user_987654321",
      "updatedBy": "user_987654321",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-06-10T14:45:00Z"
    },
    "isLive": true,
    "hasOpenDraft": false,
    "revisionsCount": 12,
    "headRevisionNumber": 12
  }
}
```

**SDK Code**

```python
import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/live';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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/live"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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/live")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
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<String> response = Unirest.post("https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/live")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/live', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/agent/id/branches/branchId/live");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "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/live")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```