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

# Start a merge — detect conflicts (write)

> Begin merging the branch into main. This recomputes and records conflicts against main's current state and reports how many changes will auto-merge. Resolve any returned conflicts, then call merge/complete — see the [branching guide](/docs/guides/branches).

**Constraints:**
- When the project requires merge approval, personal tokens need the approve permission and machine (project) tokens are rejected.



## OpenAPI

````yaml /openapi/textsetu.json post /projects/{projectId}/branches/{branchId}/merge/start
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/{branchId}/merge/start:
    post:
      tags:
        - Branches
      summary: Start a merge — detect conflicts (write)
      description: >-
        Begin merging the branch into main. This recomputes and records
        conflicts against main's current state and reports how many changes will
        auto-merge. Resolve any returned conflicts, then call merge/complete —
        see the [branching guide](/docs/guides/branches).


        **Constraints:**

        - When the project requires merge approval, personal tokens need the
        approve permission and machine (project) tokens are rejected.
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project id (UUID) or id-embedded path slug.
        - name: branchId
          in: path
          required: true
          schema:
            type: string
          description: Translation branch id (UUID).
      responses:
        '200':
          description: Detected conflicts plus the auto-mergeable count.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      conflicts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Unique conflict id (UUID) — pass this to the
                                resolve endpoint.
                              examples:
                                - c1a2b3d4-0000-4000-8000-000000000009
                            branchId:
                              type: string
                              description: Id of the branch this conflict belongs to.
                              examples:
                                - b1a2c3d4-0000-4000-8000-000000000001
                            conflictType:
                              type: string
                              description: >-
                                Kind of conflict: `value` (both sides changed
                                the same value), `key_deleted_on_main` (branch
                                edits a key deleted on main), or
                                `key_name_collision` (branch adds a key name
                                that now exists on main).
                              examples:
                                - value
                            keySnapshot:
                              type: string
                              description: >-
                                The key name captured at conflict-detection
                                time.
                              examples:
                                - checkout.summary.total
                            languageCode:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Language of the conflicting value; `null` for
                                key-level conflicts.
                              examples:
                                - fr
                            baseValue:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                The common-ancestor value both sides diverged
                                from, if known.
                              examples:
                                - Total
                            mainValue:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: The current value on main.
                              examples:
                                - Total amount
                            branchValue:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: The value proposed by the branch.
                              examples:
                                - Montant total
                            resolution:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Chosen resolution: `main`, `branch`, or
                                `custom`; `null` until resolved.
                              examples:
                                - null
                            resolvedValue:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                The final value once resolved (the `customValue`
                                when resolution is `custom`).
                              examples:
                                - null
                          required:
                            - id
                            - branchId
                            - conflictType
                            - keySnapshot
                            - languageCode
                            - baseValue
                            - mainValue
                            - branchValue
                            - resolution
                            - resolvedValue
                          additionalProperties: false
                        description: >-
                          Conflicts that must be resolved before the merge can
                          complete (empty if none).
                      autoMergeableCount:
                        type: integer
                        description: >-
                          Number of changes that will merge cleanly without
                          manual resolution.
                        examples:
                          - 17
                    required:
                      - conflicts
                      - autoMergeableCount
                    additionalProperties: false
        '400':
          description: Branch does not belong to this project.
        '403':
          description: >-
            Merge not permitted (missing approval permission or a machine
            token).
        '404':
          description: Project or branch not found.
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`.

````