Skip to content
Alex's Starlight Docs Alex's Starlight Docs
  • Auto
  • Light
  • Dark

Create

API Reference
Builds
Create a new build
post/v0/builds

Create a new build

Body Parameters
projectstring
optional

Project name

revisionunion
string OR map[ContentobjectURLobjectFileInput]

Specifies what to build: a branch name, commit SHA, merge command ("base..head"), or file contents

Hide ParametersShow Parameters
UnionMember0string

A branch name, commit SHA, or merge command in the format "base..head"

UnionMember1map

File contents to commit directly

allow_emptyboolean
optional

Whether to allow empty commits (no changes). Defaults to false.

branchstring
optional

Optional branch to use. If not specified, defaults to "main". When using a branch name or merge command as revision, this must match or be omitted.

commit_messagestring
optional

Optional commit message to use when creating a new commit.

targetsarray of Target
optional

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Returns
idstringconfig_commitstringcreated_atstringdocumented_specunionobjectenumorgstringprojectstringtargetsobjectupdated_atstringBuildObject
curl https://api.stainless.com/v0/builds \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $STAINLESS_API_KEY" \
    -d '{
      "project": "project",
      "revision": "string"
    }'
200 Example
{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}