Create an isolated child branch

The returned id is immutable; retain it for automation. The slug is a project-scoped human handle.

POST/v1/branches

Request body

requiredapplication/json

slugstringrequired

min length 1 · max length 40 · matches ^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$

namestring

min length 1 · max length 200

parent_branch_idstring

kindstring

Allowed:devpreviewtestlong_lived

originstring

Allowed:emptysource_snapshotcoordinated_fork

expires_atstring<date-time>

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Responses

201The ready branch.

objectstringrequired

idstringrequired

project_idstringrequired

parent_branch_idstring | anyrequired

Show properties

Any of:

string

string

any

any

slugstringrequired

min length 1 · max length 40 · matches ^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$

namestring | anyrequired

Show properties

Any of:

string

string

any

any

kindstringrequired

Allowed:devpreviewtestlong_lived

statestringrequired

Allowed:provisioningreadyfaileddeletingdeleted

originstringrequired

Allowed:emptysource_snapshotcoordinated_fork

rootbooleanrequired

expires_atstring | anyrequired

Show properties

Any of:

string

string

any

any

created_atstringrequired

deleted_atstring | anyrequired

Show properties

Any of:

string

string

any

any

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

401The Bearer credential is missing, malformed, or expired.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

404The addressed resource does not exist in the credential scope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

409The request conflicts with current claim, version, or idempotency state.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

500The server could not complete the request.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X POST "https://api.abloatai.com/api/v1/branches" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string",
  "name": "string",
  "parent_branch_id": "string",
  "kind": "dev",
  "origin": "empty",
  "expires_at": "2024-01-01T00:00:00Z"
}'

const response = await fetch("https://api.abloatai.com/api/v1/branches", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "slug": "string",
  "name": "string",
  "parent_branch_id": "string",
  "kind": "dev",
  "origin": "empty",
  "expires_at": "2024-01-01T00:00:00Z"
})
});

import requests

response = requests.post(
    "https://api.abloatai.com/api/v1/branches",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "slug": "string",
  "name": "string",
  "parent_branch_id": "string",
  "kind": "dev",
  "origin": "empty",
  "expires_at": "2024-01-01T00:00:00Z"
},
)

Response

{
  "object": "branch",
  "id": "string",
  "project_id": "string",
  "parent_branch_id": "string",
  "slug": "string",
  "name": "string",
  "kind": "dev",
  "state": "provisioning",
  "origin": "empty",
  "root": true,
  "expires_at": "string",
  "created_at": "string",
  "deleted_at": "string"
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}