> ## Documentation Index
> Fetch the complete documentation index at: https://docs.textsetu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a branch (write)

> Create a new branch off main. Branch edits are staged as an overlay and only reach main on merge — see the [branching guide](/docs/guides/branches).

**Constraints:**
- Requires branching to be enabled on the project.
- The branch name must be unique in the project and match the allowed name pattern.



## OpenAPI

````yaml /openapi/textsetu.json post /projects/{projectId}/branches
openapi: 3.1.0
info:
  title: TextSetu API
  version: 1.2.0
  description: >-
    Public REST API for TextSetu. Authenticate with a Personal Access Token
    (tsu_pat_…) or a project token (tsu_proj_…) via the `Authorization: Bearer
    <token>` header.


    **Authorization is permission-based.** Every token carries an explicit
    allow-list of RBAC permission keys (e.g. `translation_read`), and each
    endpoint declares the permission it requires (`x-permission`). A token's
    effective access is its underlying authority ∩ its allow-list — a PAT is
    further bounded by its owner's role-based permissions, so it can only
    narrow, never exceed, what the owner already has. A project token is bound
    to a single project. There are no coarse read/write/manage scopes.


    **Response envelope.** Every endpoint returns `{ "success": true, "data": …
    }` on success and `{ "success": false, "error": { "code", "message" } }` on
    failure.


    **Rate limit.** 600 requests/minute, keyed by token (or by IP when
    unauthenticated). Exceeding it returns 429 with the standard error envelope.
servers:
  - url: https://api.textsetu.com/api/v1
    description: Production
  - url: /api/v1
    description: This server (self-hosted / same-origin)
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Read project metadata — settings, key separator, and the
      approval/branching flags that shape how the other endpoints behave.
  - name: Languages
    description: >-
      List and manage a project's target languages. Each language is referenced
      by its BCP-47 code; the source language is flagged separately.
  - name: Translations
    description: >-
      Manage a project's translations: create, read, update, and delete
      translation keys — the identifiers your app looks up, carrying metadata
      (description, tags, screenshot) — and set the translated value for a key
      in a given language. Value writes honor the project's approval workflow —
      non-approver writes land as `pending_review`.
  - name: Stats
    description: >-
      Per-language completeness and approval progress for a project — the
      numbers behind the dashboard.
  - name: Import/Export
    description: >-
      Bulk-load source files into a project or export the current translations.
      Supports the same file formats as the web app.
  - name: Branches
    description: >-
      Work on translations in isolation and merge them back. Branch reads/writes
      mirror the main endpoints but stage changes as a diff until merge. See the
      [branching guide](/docs/guides/branches).
  - name: Glossary
    description: >-
      Manage term bases — approved terminology and its translations — and check
      a string against them. See the [glossary guide](/docs/guides/glossary).
  - name: Translation Memory
    description: >-
      Reusable translation stores. Fuzzy-match and concordance-search prior
      translations to reuse them. See the [translation memory
      guide](/docs/guides/translation-memory).
  - name: AI
    description: >-
      Machine-translate a project with the org's configured AI engine (brand
      voice, glossary/TM grounding, and an optional review pass). Runs
      asynchronously — start a run and poll the returned `jobId`.
  - name: Webhooks
    description: >-
      Get notified when a project's translations change, instead of polling.
      Register an HTTPS endpoint, subscribe it to the events you care about, and
      TextSetu POSTs a signed payload whenever one occurs. Payloads follow the
      [Standard Webhooks](https://www.standardwebhooks.com) spec — verify the
      `webhook-signature` header with any compatible library. Delivery is
      at-least-once and unordered, so treat `webhook-id` as an idempotency key.
      Failed deliveries are retried five times over roughly seven hours, and
      every attempt is inspectable and replayable via the delivery log.
  - name: Meta
    description: Service-level and cross-cutting endpoints.
paths:
  /projects/{projectId}/branches:
    post:
      tags:
        - Branches
      summary: Create a branch (write)
      description: >-
        Create a new branch off main. Branch edits are staged as an overlay and
        only reach main on merge — see the [branching
        guide](/docs/guides/branches).


        **Constraints:**

        - Requires branching to be enabled on the project.

        - The branch name must be unique in the project and match the allowed
        name pattern.
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project id (UUID) or id-embedded path slug.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  pattern: ^[a-z0-9][a-z0-9-]*$
                description:
                  type: string
                  maxLength: 500
              required:
                - name
      responses:
        '201':
          description: The created branch (with zero diff stats).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      branch:
                        type: object
                        properties:
                          id:
                            type: string
                            description: Unique branch id (UUID).
                            examples:
                              - b1a2c3d4-0000-4000-8000-000000000001
                          projectId:
                            type: string
                            description: Id of the project this branch belongs to.
                            examples:
                              - proj_9f8e7d6c
                          name:
                            type: string
                            description: >-
                              Human-readable branch name, unique within the
                              project.
                            examples:
                              - feature/checkout-copy
                          description:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              Optional free-text note describing the branch's
                              purpose.
                            examples:
                              - Reworked checkout wording for the Q1 launch.
                          status:
                            type: string
                            description: >-
                              Lifecycle state: `active` while open, `merged`
                              once merged into main.
                            examples:
                              - active
                          isApproved:
                            type: boolean
                            description: >-
                              True once the merge has been approved (set when
                              merge approval is granted).
                            examples:
                              - false
                          createdAt:
                            type: string
                            description: Creation timestamp (ISO 8601).
                            examples:
                              - '2026-01-15T09:24:00.000Z'
                          mergedAt:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              Timestamp the branch was merged into main (ISO
                              8601); `null` until merged.
                            examples:
                              - null
                          stats:
                            type: object
                            properties:
                              keysAdded:
                                type: integer
                                description: >-
                                  Number of keys created on the branch that
                                  don't exist on main.
                                examples:
                                  - 4
                              keysDeleted:
                                type: integer
                                description: >-
                                  Number of main keys staged for deletion by the
                                  branch.
                                examples:
                                  - 1
                              valuesModified:
                                type: integer
                                description: >-
                                  Number of translation values the branch
                                  overrides relative to main.
                                examples:
                                  - 12
                              languagesAdded:
                                type: integer
                                description: >-
                                  Number of languages added on the branch but
                                  not present on main.
                                examples:
                                  - 1
                              languagesDeleted:
                                type: integer
                                description: >-
                                  Number of main languages staged for removal by
                                  the branch.
                                examples:
                                  - 0
                            required:
                              - keysAdded
                              - keysDeleted
                              - valuesModified
                              - languagesAdded
                              - languagesDeleted
                            additionalProperties: false
                            description: Diff summary of the branch against main.
                        required:
                          - id
                          - projectId
                          - name
                          - description
                          - status
                          - isApproved
                          - createdAt
                          - mergedAt
                          - stats
                        additionalProperties: false
                    required:
                      - branch
                    additionalProperties: false
        '400':
          description: Branching is not enabled for this project.
        '403':
          description: Token has no associated user for attribution.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's
        granted RBAC permissions determine access; see each operation's
        `x-permission`.

````