--- title: "Creates two builds whose outputs can be compared directly" method: POST path: "/v0/builds/compare" --- # Creates two builds whose outputs can be compared directly `POST /v0/builds/compare` ## Request body - object - `project` string, required — Project name - `base` object, required — Parameters for the base build - `revision` union, required — Specifies what to build: a branch name, a commit SHA, or file contents - string — A branch name, commit SHA, or merge command in the format "base..head" - object — File contents to commit directly - `branch` string — Optional branch to use. If not specified, defaults to "main". When using a branch name as revision, this must match or be omitted. - `commit_message` string — Optional commit message to use when creating a new commit. - `head` object, required — Parameters for the head build - `revision` union, required — Specifies what to build: a branch name, a commit SHA, or file contents - string — A branch name, commit SHA, or merge command in the format "base..head" - object — File contents to commit directly - `branch` string — Optional branch to use. If not specified, defaults to "main". When using a branch name as revision, this must match or be omitted. - `commit_message` string — Optional commit message to use when creating a new commit. - `targets` Target[] — Optional list of SDK targets to build. If not specified, all configured targets will be built. ## Response `200` success - object - `base` BuildObject, required - `object` 'build', required - `id` string, required - `updated_at` string, date-time, required - `created_at` string, date-time, required - `project` string, required - `org` string, required - `config_commit` string, required - `documented_spec` union, required - object - `type` 'content', required - `content` string, required - object - `type` 'url', required - `url` string, required - `expires` string, date-time, required - `targets` object, required - `node` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `typescript` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `python` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `go` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `java` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `kotlin` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `ruby` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `terraform` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `cli` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `php` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `csharp` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `head` BuildObject, required - `object` 'build', required - `id` string, required - `updated_at` string, date-time, required - `created_at` string, date-time, required - `project` string, required - `org` string, required - `config_commit` string, required - `documented_spec` union, required - object - `type` 'content', required - `content` string, required - object - `type` 'url', required - `url` string, required - `expires` string, date-time, required - `targets` object, required - `node` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `typescript` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `python` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `go` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `java` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `kotlin` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `ruby` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `terraform` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `cli` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `php` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required - `csharp` BuildTarget - `object` 'build_target', required - `status` 'not_started' | 'codegen' | 'postgen' | 'completed', required - `commit` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `lint` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `test` union, required - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `build` union - object - `status` 'not_started', required - object - `status` 'queued', required - object - `status` 'in_progress', required - object - `status` 'completed', required - `completed` object, required - … - `install_url` string, nullable, required ## Changes - **2025-08-12** `c9dbcee416d3` — 88 breaking, 22 warning, 730 info - added `#/components/schemas/Commit, subschema #2` to the `base/targets/cli/commit/oneOf[subschema #4]/completed/commit` response property `oneOf` list for the response status `200` - added `#/components/schemas/Commit, subschema #2` to the `base/targets/csharp/commit/oneOf[subschema #4]/completed/commit` response property `oneOf` list for the response status `200` - added `#/components/schemas/Commit, subschema #2` to the `base/targets/go/commit/oneOf[subschema #4]/completed/commit` response property `oneOf` list for the response status `200` - added `#/components/schemas/Commit, subschema #2` to the `base/targets/java/commit/oneOf[subschema #4]/completed/commit` response property `oneOf` list for the response status `200` - …836 more - **2025-07-07** `f8b160dfac6c` — 90 info - added the required property `base/documented_spec/oneOf[subschema #2]/expires` to the response with the `200` status - added the required property `base/targets/cli/build/oneOf[subschema #4]/completed/url` to the response with the `200` status - added the required property `base/targets/cli/lint/oneOf[subschema #4]/completed/url` to the response with the `200` status - added the required property `base/targets/cli/test/oneOf[subschema #4]/completed/url` to the response with the `200` status - …86 more [Change history](https://skmtc.dev/stainless-api/apis/my-api/changes/v0/builds/compare/post.md) --- [API](https://skmtc.dev/stainless-api/apis/my-api.md) · [All operations](https://skmtc.dev/stainless-api/apis/my-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stainless-api/my-api/revisions/c9dbcee416d3/schema)