# dev.knotless.createBranch

> Published by [lexicons.knotless.dev](https://lexicon.garden/identity/did:plc:yqsg7znbbhfmj3a2nrpnaerk)

✓ This is the authoritative definition for this NSID.

## Description

Creates a branch of a repository.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.createBranch)
- [Documentation](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.createBranch/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.createBranch/examples)

## Definitions

### `dev.knotless.createBranch`

**Type**: `procedure`

Points a new branch at a commit or branch, the default branch when none is named, as `knotless branch` does. As the account logged in to this appview's web pages: directly for the owner, through the repository's gateway for a collaborator, which refuses anyone else.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `from` | `string` | No | The commit, by hex, or branch it starts at: the default branch when absent. |
| `name` | `string` | Yes | The branch, without refs/heads/. |
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The branch, without refs/heads/. |
| `sha` | `string` | No | The commit it points at, in hex, once made. |

#### Errors

- **NotFound**: No such repository.
- **InvalidRequest**: The branch exists already, there is no such commit or branch to start at, or the gateway refused it.
- **AuthenticationRequired**: No account is logged in to the pages, or its session has ended.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Points a new branch at a commit or branch, the default branch when none is named, as `knotless branch` does. As the account logged in to this appview's web pages: directly for the owner, through the repository's gateway for a collaborator, which refuses anyone else.",
      "errors": [
        {
          "description": "No such repository.",
          "name": "NotFound"
        },
        {
          "description": "The branch exists already, there is no such commit or branch to start at, or the gateway refused it.",
          "name": "InvalidRequest"
        },
        {
          "description": "No account is logged in to the pages, or its session has ended.",
          "name": "AuthenticationRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "from": {
              "description": "The commit, by hex, or branch it starts at: the default branch when absent.",
              "maxLength": 255,
              "type": "string"
            },
            "name": {
              "description": "The branch, without refs/heads/.",
              "maxLength": 255,
              "type": "string"
            },
            "repo": {
              "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "repo",
            "name"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "name": {
              "description": "The branch, without refs/heads/.",
              "type": "string"
            },
            "sha": {
              "description": "The commit it points at, in hex, once made.",
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "description": "Creates a branch of a repository.",
  "id": "dev.knotless.createBranch",
  "lexicon": 1
}
```