Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ npm run dev

## Build It With an AI Agent

Bitbybit has 1901 functions across three CAD kernels - more than any model remembers, so an agent working from memory invents plausible names that do not exist. Give it the **[Bitbybit CAD MCP](https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/bitbybit-mcp)** instead and it looks up the exact signature, defaults, return type and examples for the version you have installed. It is free and needs no account:
Bitbybit has 1919 functions across three CAD kernels - more than any model remembers, so an agent working from memory invents plausible names that do not exist. Give it the **[Bitbybit CAD MCP](https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/bitbybit-mcp)** instead and it looks up the exact signature, defaults, return type and examples for the version you have installed. It is free and needs no account:

```bash
claude mcp add --transport http bitbybit https://mcp.bitbybit.dev/mcp
Expand Down
2 changes: 1 addition & 1 deletion docs/api/openapi-docs/bitbybit-cad-cloud-api.info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import Export from "@theme/ApiExplorer/Export";

<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 1.4.0"}
children={"Version: 1.4.1"}
>
</span>

Expand Down
45 changes: 2 additions & 43 deletions docs/api/openapi-docs/cad-execute-a-chained-pipeline.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Runs multiple operations sequentially. Use '$ref:N' in params to r
sidebar_label: "CAD - execute a chained pipeline"
hide_title: true
hide_table_of_contents: true
api: eJztW21vI7cR/iuDRQHJxWrte0lRqEEAx75rlN7ZhuVLmxhGQO2OJMZcco/kyqfz+b8XM+SuVi85+9KmLVB9sfXCJWeGM888M6TuEy9mLhleJyfHp3BeoRVeGu2SmzQp0OVWVvQ+GSaXtXZQ1srLSiGYdiQ4fF+j9lIotczgnUPo/cHidHjWA6mhElaUDrwBi1O0qHME57GCs54Di65WPkvSxNIkzn9rimUyvOe30mKRDL2tMU1yoz1qT1+JqlIy57UPf3Ek2n3i8jmWgl75ZYXJMDGTXzD3SZpUliT1Eh2P81jxi1LqkcfSJcNnaVKKD/HNV0dpM4OwViyTNJHhm/tE6OX5NBleP7ZG+LYd5byVepawCs4nw6QUVbJp21PMlbDowM+lC+YRDgSUooK+9NHUB/xN8tARan2asaltjsCik8XDkwhmgTaDq2Ulc9okEKsdWm2KNyCgsriQpo4y+LnwUFlT1DkWIHSYOSMJdlvy12z3eYu1vrTLbKXUb1DP/JwXWNf3da3UcvC+FkpOJRZALtxOBrIgr5xKtNDHbJZBz+S5z9xcVOgyZ5Qsstyi8Diu5mixd5DBuK4qY72D85OTqxTeCi2nRhUpfD8+OT5NQegCFph7Yw9L4eedMGCrBGff3pg2rkI4oEfrNkIlishvj3oH6wHj5wim9lXtwUy3tmmyBOkdfERrBhPhsACpC/zQLDCVCodn18Ovp8aWwn9zcz38OjcF5t/c9NaXERqkpkXokZ6DGHUOBtA8DNKB0UhiePzgP03q6RTtp1pq/+dPFI6fSII/vYR+gVNRK8/DDoLlWA22iVAQZehMaMXdp1mtP8rqk6i9WU1hxR0bpMDclJVF53gqkhKm0jr/F+jREz0Ij9OMagl3c9Qw+ygrKMVM5jBZenQgLJL9HGqfgjONgY6GJOgwTGNRFA4mxs+hUkJqlp5mGjQCYAF1pQwNCzuXhajVBb2qPh6wP4Q92/aHv5NkjGyriG/hkCwida7qgncSBDgkt/HY4CXZufEHoYyeOVnQ7i2BnZsN4whVYzBNjFEodPLwkHaQ9boTeK3rbsH+MTipZyqCdhSnAXyOuEpWqKTGDMYECpAL3fGpIKaj/UVhFUUjYwcspADydjC243Xxc3rJCkivSIOLuMY4AuAG7tWTQZjUG8APmNceYWosoMjnhIJlEwv0usdfkQPltbWoPaDCkt2h9weOnNWIFntB1+UELe+qRQLEXVEeXdt15clNOZEaGcvD/rWhX4rqkj/pbYd7bpTC3BPuMpybaUeYaNTOFu8hdw+5e8jdQ+7vBbmberCaDdw0dHBLk1GHgLb8MY0QLfWsg5QtXEcwzuAiEE/XPsgOGxAU+saCgIDEBSyEqvGgK/1bUcVc8a/y9XxuZI5PpuxhOPRzowsZ4m7F21nObd/8gT6OuaISFn8LV29KKQoB9jFjtxc64fkl+3IcxHNVlVrCBP0dog7G5LCK4lyZlV+35kFdl+QI+D5JE81/Z57/kK2U5z/0Ej9I59k3mr1ZSXHeSPpA9m4We9Q+IGZCauczODMeGrdkF+qF5XqtfmwRP0e9L1b2mXOfOfeZ83+yWOHdb1MGGZUMTg+jcjsyxhMnmQrlMIPRFEwpvccibdo5DnSt1L6A2MPgHgb3MPjfKyACI+5w1kjWtnQ6WfHppn4wGgaANAPZWXSgj7bU1po9rhQ+n1OtMbFC5/OuhCfM1Z9YJ+wRb494e8TbI96TEW+HkI0QQcwBoPRz6ozE/Ws1TbfP/lLgjseu9sIuEY71cjf9PLcFUrGspOMwXUMj13DJYuNU943wrUnWLdeYq2nM1LQRK8BwS+3Fhw5kkVrcWwiKUPBaowZTZe7C/OySbOrXZOltt7xs1mby24CMWkZXp0YAe9YasPBZNFt9dSAtNQF9CNAWRPpN6Ktl+3ALSg0kMSJVMr/lHpTg1kMpPCl2aGwXAQbgEKHrGFkQgHetc/L8W4k4STgqvjQnjU7XIXrTetCfWlPCxfn4Cg7ZnIfh+wM+ADFqZ8vscyteGoXdZNecsITVQlqh/RmUpkDVS6GXG2MLqYVHN8jdonewhQxR9yjQTZqIogmKi46RuArakmetmaY31PcGJgg1AahwIfA7QTZqvJM2j6WK+LEjpwb8i/4RfMtxw42ogDfRBpRqWnCI+LmKGULSFHK3SMF5lcKLcsoYF7WlaZwXuhC28US3XvRZcdfAdiG8AAZzY7HowO+v+VeY70u7Z1t9Qm6BUqO4+si9VIoQ47AYlOjm1DdUfpqkCd/oSJPcLXiwStLkRTndBvwmopoEE7Isy5rBKOQlB0KpLctApWo3hB6t1IP+9+PzMzbKAbmcW/SgfzL+oeEDPedVD/oTqYVdwvjqDZC4MGg51yFTLs7kNPxFOe1B/8Xb12FcJfJbMcNfGb8Lt4O/vGZRd4B315sYw2aoucXe8ZZWYVqoGdon+5P7VB9TIFunsLEHB2yY1gsHrsJcTmW+mmKHGwYCQY9fWMyli/R4XeorYiJKRWrZjGMEoCcjG2xScH9DrsBqlJ8eZPDG3KENDWrXdDKgQO0wTLXGJ8KJbYAlWZIXHmVHR0fhwk/44NkR9adFWdEeHGXPOucHayo9BP98+3k9zxdoLXEcv1vhxqKcW0j7mbp6HfXOgNmWQ5+CF7esHuZYBHayiPpdrBkvPK7V8ndTWhS/1M7/6M1Pu84S9AKtB04UPw7qitzxJ/q/Am5wS+exJLBaFQecmKe1Yh2cmfo7Irt81wg/VJh7x9PsYoZEDDi0m3AZ6bfoBYXvtoARBQLC1qoDsAVOpY5NMg1lnIEJawangc5zdBH5zWCMnt5wGgn9tjCx9EGFUijFGxTneZzSNqD6WMrajQ7hnoHbmrU9hPuCNPgq9g6JWTIFncK30k+WE+k3qeE6I2zhJjC95hCqoWYpRO4UkJkzqEuZ/bWcNt0ggo3Qbhcw8s3Ah9hGcJXRLuSn50fPdyCOcLcg8hwrj0Xyb7s+aG47Y5q9bU8KyVkIsaMzPnLqKNztbtq2rsk7Ld/T2Rcp1GFPA+ImoSojJmpUjCYvfO1C+wO9lbho2AQd0gavS4ZJXcsiXOKj4Z87/HxfY80W3AwtyYUVixUX7Qt1J5YOeuGZHtSV0cCtC6pfVuu9s+pxvS+R4HOB8O7yzZqK3SXrqiB2mHTwLDkUlTxcPDukce7wPtj5YStWov1bG3SF+1Ii6WursQiFvOCoCdvlWhfM4ILkJyRqlwn4IvJbSmQzKha6bk8efMJtnyJcEdoui2+T6GxfJu93V1cX8PzoOTRh1Ai+KTSbW7ilzknCHJ0LG9UV8TiOvYxzxQh9eXS08xRXFiEnorXc6vuPxCVbgU5SeNFHJ6MK73H/fCuoqYgDqv7ERGFQCfjhrjv+cPxmdHp8NTo/+/nV5eX5ZaRLTsyesMh3dSn05hLN00wOvZBqZyevuYnmbZ37mgr+RkBN1DZ5aK9cBxTa9Gn+CkanIeasyOPer8m76ZJR+0bCL/PL8aaoUgfAIoe5k34O5abNaT0Gu7ZdV+Ckns2oA9EouvLXVzTrKZtsdzAFB/lSqSPZDjKjXqAy3NleW3YjPr7aFR9jtMTz9rGxj43/39hgF/BzUyTDpDKOXVBQQ6lN7LkoDhsmT2mbo8bxDzNqYhbJ3PvKDQ9pfDaJXDYrcLHlQuGCGb+hZq3DvLbSL3mq40r+DZfHNS19fdP9ekyBF8KhO6j1V8EfUkuE1pijKLge06Kkb/8xOL4YDcKADWvlpsICji9GcItEsOm9GwL3w1wKuShS2jkqulL4I/TvpCpyYYuDDI7pEXYEU3umGe2lKEfTANWScoEOXh69gNHZ+N3r16OT0auzq5/HJ+cXrzLedIKWy9XvcF41gdr+bmb125fwI5bVx53DsVXANucKTIxvVvemnza+cyLXXsFb3WwL987Cva6nrh+uUjx99SdN2u1UX6/asasHQrO0hYWbtWZh212LDbKbrWYKF+g7mg/8ebc+Dz+U+kx9zBJzCT3lO3ZNEK7VeyfK1OyEdDaLNqyVPMteZkfbECxn80GFlpWgPkU8NrQy57nYc5sOFSHV8cWoexJAvyUbNJ3R0Nnqj69eXaTw1zdXr7sNKm5+HKSrCr49AU65vowtpBAdri0tA3n9xUw6BDaLqVXknFpjWDY2SNINEFkDELpJiLZ051PK1eSSuwce8qiB0MWgLWupxFAyp15VZ13CUCvRC7v87NK7Z6TdJJAshe7MSaYftJeCYmGPBXRAc20f71dU43f+kV8MZ8o9h3ziRRatQzkYUP6a4JNc7xltk6ACrRX7Jk3mlBGG18n9PW34O6seHujj9zVagu0buk9gJeU/Ru20gV+KzFtchq4VqTq46l4/GG4zLIr/8EQocT479qaTtOjIJEmTSfwhY8mMKbHijqBA3CXDhHEsbCD90pE+u0+U0LOaiU9ogXMu/Ccc3zRw
api: eJztW21vI7cR/iuDRQHJxWrte0lRqEEAx75rlN7ZhuVLmxhGQO2OJMZcco/kyqfz+b8XM+SuVi85+9KmLVB9sfXCJWeGM888M6TuEy9mLhleJyfHp3BeoRVeGu2SmzQp0OVWVvQ+GSaXtXZQ1srLSiGYdiQ4fF+j9lIotczgnUPo/cHidHjWA6mhElaUDrwBi1O0qHME57GCs54Di65WPkvSxNIkzn9rimUyvOe30mKRDL2tMU1yoz1qT1+JqlIy57UPf3Ek2n3i8jmWgl75ZYXJMDGTXzD3SZpUliT1Eh2P81jxi1LqkcfSJcNnaVKKD/HNV0dpM4OwViyTNJHhm/tE6OX5NBleP7ZG+LYd5byVepawCs4nw6QUVbJp21PMlbDowM+lC+YRDgSUooK+9NHUB/xN8tARan2asaltjsCik8XDkwhmgTaDq2Ulc9okEKsdWm2KNyCgsriQpo4y+LnwUFlT1DkWIHSYOSMJdlvy12z3eYu1vrTLbKXUb1DP/JwXWNf3da3UcvC+FkpOJRZALtxOBrIgr5xKtNDHbJZBz+S5z9xcVOgyZ5Qsstyi8Diu5mixd5DBuK4qY72D85OTqxTeCi2nRhUpfD8+OT5NQegCFph7Yw9L4eedMGCrBGff3pg2rkI4oEfrNkIlishvj3oH6wHj5wim9lXtwUy3tmmyBOkdfERrBhPhsACpC/zQLDCVCodn18Ovp8aWwn9zcz38OjcF5t/c9NaXERqkpkXokZ6DGHUOBtA8DNKB0UhiePzgP03q6RTtp1pq/+dPFI6fSII/vYR+gVNRK8/DDoLlWA22iVAQZehMaMXdp1mtP8rqk6i9WU1hxR0bpMDclJVF53gqkhKm0jr/F+jREz0Ij9OMagl3c9Qw+ygrKMVM5jBZenQgLJL9HGqfgjONgY6GJOgwTGNRFA4mxs+hUkJqlp5mGjQCYAF1pQwNCzuXhajVBb2qPh6wP4Q92/aHv5NkjGyriG/hkCwida7qgncSBDgkt/HY4CXZufEHoYyeOVnQ7i2BnZsN4whVYzBNjFEodPLwkHaQ9boTeK3rbsH+MTipZyqCdhSnAXyOuEpWqKTGDMYECpAL3fGpIKaj/UVhFUUjYwcspADydjC243Xxc3rJCkivSIOLuMY4AuAG7tWTQZjUG8APmNceYWosoMjnhIJlEwv0usdfkQPltbWoPaDCkt2h9weOnNWIFntB1+UELe+qRQLEXVEeXdt15clNOZEaGcvD/rWhX4rqkj/pbYd7bpTC3BPuMpybaUeYaNTOFu8hdw+5e8jdQ+7vBbmberCaDdw0dHBLk1GHgLb8MY0QLfWsg5QtXEcwzuAiEE/XPsgOGxAU+saCgIDEBSyEqvGgK/1bUcVc8a/y9XxuZI5PpuxhOPRzowsZ4m7F21nObd/8gT6OuaISFn8LV29KKQoB9jFjtxc64fkl+3IcxHNVlVrCBP0dog7G5LCK4lyZlV+35kFdl+QI+D5JE81/Z57/kK2U5z/0Ej9I59k3mr1ZSXHeSPpA9m4We9Q+IGZCauczODMeGrdkF+qF5XqtfmwRP0e9L1b2mXOfOfeZ83+yWOHdb1MGGZUMTg+jcjsyxhMnmQrlMIPRFEwpvccibdo5DnSt1L6A2MPgHgb3MPjfKyACI+5w1kjWtnQ6WfHppn4wGgaANAPZWXSgj7bU1po9rhQ+n1OtMbFC5/OuhCfM1Z9YJ+wRb494e8TbI96TEW+HkI0QQcwBoPRz6ozE/Ws1TbfP/lLgjseu9sIuEY71cjf9PLcFUrGspOMwXUMj13DJYuNU943wrUnWLdeYq2nM1LQRK8BwS+3Fhw5kkVrcWwiKUPBaowZTZe7C/OySbOrXZOltt7xs1mby24CMWkZXp0YAe9YasPBZNFt9dSAtNQF9CNAWRPpN6Ktl+3ALSg0kMSJVMr/lHpTg1kMpPCl2aGwXAQbgEKHrGFkQgHetc/L8W4k4STgqvjQnjU7XIXrTetCfWlPCxfn4Cg7ZnIfh+wM+ADFqZ8vscyteGoXdZNecsITVQlqh/RmUpkDVS6GXG2MLqYVHN8jdonewhQxR9yjQTZqIogmKi46RuArakmetmaY31PcGJgg1AahwIfA7QTZqvJM2j6WK+LEjpwb8i/4RfMtxw42ogDfRBpRqWnCI+LmKGULSFHK3SMF5lcKLcsoYF7WlaZwXuhC28US3XvRZcdfAdiG8AAZzY7HowO+v+VeY70u7Z1t9Qm6BUqO4+si9VIoQ47AYlOjm1DdUfpqkCd/oSJPcLXiwStLkRTndBvwmopoEE7Isy5rBKOQlB0KpLctApWo3hB6t1IP+9+PzMzbKAbmcW/SgfzL+oeEDPedVD/oTqYVdwvjqDZC4MGg51yFTLs7kNPxFOe1B/8Xb12FcJfJbMcNfGb8Lt4O/vGZRd4B315sYw2aoucXe8ZZWYVqoGdon+5P7VB9TIFunsLEHB2yY1gsHrsJcTmW+mmKHGwYCQY9fWMyli/R4XeorYiJKRWrZjGMEoCcjG2xScH9DrsBqlJ8eZPDG3KENDWrXdDKgQO0wTLXGJ8KJbYAlWZIXHmVHR0fhwk/44NkR9adFWdEeHGXPOucHayo9BP98+3k9zxdoLXEcv1vhxqKcW0j7mbp6HfXOgNmWQ5+CF7esHuZYBHayiPpdrBkvPK7V8ndTWhS/1M7/6M1Pu84S9AKtB04UPw7qitzxJ/q/Am5wS+exJLBaFQecmKe1Yh2cmfo7Irt81wg/VJh7x9PsYoZEDDi0m3AZ6bfoBYXvtoARBQLC1qoDsAVOpY5NMg1lnIEJawangc5zdBH5zWCMnt5wGgn9tjCx9EGFUijFGxTneZzSNqD6WMrajQ7hnoHbmrU9hPuCNPgq9g6JWTIFncK30k+WE+k3qeE6I2zhJjC95hCqoWYpRO4UkJkzqEuZ/bWcNt0ggo3Qbhcw8s3Ah9hGcJXRLuSn50fPdyCOcLcg8hwrj0Xyb7s+aG47Y5q9bU8KyVkIsaMzPnLqKNztbtq2rsk7Ld/T2Rcp1GFPA+ImoSojJmpUjCYvfO1C+wO9lbho2AQd0gavS4ZJXcsiXOKj4Z87/HxfY80W3AwtyYUVixUX7Qt1J5YOeuGZHtSV0cCtC6pfVuu9s+pxvS+R4HOB8O7yzZqK3SXrqiB2mHTwLDkUlTxcPDukce7wPtj5YStWov1bG3SF+1Ii6WursQiFvOCoCdvlWhfM4ILkJyRqlwn4IvJbSmQzKha6bk8efMJtnyJcEdoui2+T6GxfJu93V1cX8PzoOTRh1Ai+KTSbW7ilzknCHJ0LG9UV8TiOvYxzxQh9eXS08xRXFiEnorXc6vuPxCVbgU5SeNFHJ6MK73H/fCuoqYgDqv7ERGFQCfjhrjv+cPxmdHp8NTo/+/nV5eX5ZaRLTsyesMh3dSn05hLN00wOvZBqZyevuYnmbZ37mgr+RkBN1DZ5aK9cBxTa9Gn+CkanIeasyOPer8m76ZJR+0bCL/PL8aaoUgfAIoe5k34O5abNaT0Gu7ZdV+Ckns2oA9EouvLXVzTrKZtsdzAFB/lSqSPZDjKjXqAy3NleW3YjPr7aFR9jtMTz9rGxj43/39hgF/BzUyTDpDKOXVBQQ6lN7LkoDhsmT2mbo8bxDzNqYhbJ3PvKDQ9pfDaJXDYrcLHlQuGCGb+hZq3DvLbSL3mq40r+DZfHNS19fdP9ekyBF8KhO6j1V8EfUkuE1pijKLge06Kkb/8xOL4YDcKADWvlpsICji9GcItEsOm9GwL3w1wKuShS2jkqulL4I/TvpCpyYYuDDI7pEXYEU3umGe2lKEfTANWScoEOXh69gNHZ+N3r16OT0auzq5/HJ+cXrzLedIKWy9XvcF41gdr+bmb125fwI5bVx53DsVXANucKTIxvVvemnza+cyLXXsFb3WwL987Cva6nrh+uUjx99SdN2u1UX6/asasHQrO0hYWbtWZh212LDbKbrWYKF+g7mg/8ebc+Dz+U+kx9zBJzCT3lO3ZNEK7VeyfK1OyEdDaLNqyVPMteZs+2IVjO5oMKLStBfYp4bGhlznOx5zYdKkKq44tR9ySAfks2aDqjobPVH1+9ukjhr2+uXncbVNz8OEhXFXx7ApxyfRlbSCE6XFtaBvL6i5l0CGwWU6vIObXGsGxskKQbILIGIHSTEG3pzqeUq8kldw885FEDoYtBW9ZSiaFkTr2qzrqEoVaiF3b52aV3z0i7SSBZCt2Zk0w/aC8FxcIeC+iA5to+3q+oxu/8I78YzpR7DvnEiyxah3IwoPw1wSe5HnlbLqhAa8W+SZM5ZYThdXJ/Txv+zqqHB/r4fY2WYPuG7hNYSfmPUTtt4Jci8xaXoWtFqg6uutcPhtsMi+I/PBFKnM+OvekkLToySdJkEn/IWDJjSqy4IygQd8kwYRwLG0i/dKTP7hMl9Kxm4hNa4JwL/wkgUjRx
sidebar_class_name: "post api-method"
info_path: api/open/bitbybit-cad-cloud-api
custom_edit_url: null
Expand Down Expand Up @@ -64,46 +64,5 @@ Runs multiple operations sequentially. Use '$ref:N' in params to reference step

</StatusCodes>

{/* static-reference:generated */}

## Reference

`POST /api/v1/cad/pipeline`

Runs multiple operations sequentially. Use '$ref:N' in params to reference step N's result.

### Request body

Content type: `application/json` (required)

| Field | Type | Required | Description |
|---|---|---|---|
| `steps` | array of object | yes | Ordered list of CAD operations executed sequentially. Later steps can reference earlier results using '$ref:N' syntax. Supports map and choice control-flow steps. |
| `inputFiles` | array of object | no | References to previously uploaded files. Use '$file:N' in step params to inject file contents (optionally '$file:N:&lt;format&gt;:&lt;codec&gt;' to pick a read format and/or decompress - see PipelineStep.params). |
| `inputFiles[].fileId` | string | yes | ID of a previously uploaded file (from POST /files/upload) |
| `inputFiles[].role` | string | yes | Role identifier for the file (e.g. 'step-model', 'coordinates-csv') |
| `outputs` | object | no | Controls which output formats are generated for pipeline results. Supports additional formats (json, csv, stl, 3mf) beyond standard model outputs. |
| `outputs.formats` | array of object | yes | Output formats to generate. Supports standard CAD formats (step, stpz, gltf, decomposed-mesh) plus pipeline-specific formats (json, csv, stl, 3mf). |
| `outputs.meshPrecision` | number | no | Mesh tessellation precision (lower = finer). Range: [0.0001, 10] |
| `outputs.gltfMeshPrecision` | number | no | Mesh tessellation precision (lower = finer). Range: [0.0001, 10] |
| `outputs.adjustYtoZ` | boolean | no | Convert from Y-up to Z-up coordinate system in the output. Useful for software that expects Z-up. |
| `outputs.includePipelineInMetadata` | boolean | no | Include the full pipeline definition in metadata.json. Defaults to true. Set to false to exclude it for smaller metadata. |

### Responses

| Status | Description |
|---|---|
| `202` | Task accepted |
| `400` | Validation error |
| `500` | Server error |

### Example request

```bash
curl -X POST "https://api.bitbybit.dev/api/v1/cad/pipeline" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'
```

Authentication: send your key in the `x-api-key` header. The full machine-readable specification is at [openapi.json](https://learn.bitbybit.dev/openapi.json).

37 changes: 2 additions & 35 deletions docs/api/openapi-docs/cad-execute-a-single-operation.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Runs a single CAD operation by its fully-qualified identifier."
sidebar_label: "CAD - execute a single operation"
hide_title: true
hide_table_of_contents: true
api: eJztWEtvGzcQ/isEL44LamW76UU3xY9GbRoLkhwUMIyAIkda2lxyzYccQdB/L4ZcSSvZTWK06KXRSbsczvP7hpxd0cDnnvZu6Xn/glzX4HhQ1nh6x6gEL5yq8Zn26CgaTzjxysw1EJS2G2kyXRIVPJlFrZedx8i1mimQREkwAf+6gjLq4DGCD++sXNLeKj0qB5L2govAqLAmgAm4xOtaK5FUd+89Wl9RL0qoOP4Lyxpoj9rpPYhAGa0dOhIUeFzdOtUS9cEpM6eMVsp8ADMPJe2dHsZ3deD8foS7UMgbKOYFObJChMKXvAZfeKuVLIQDHuCd/XLEyFHFjZpZLYvaqUoFtQBfiDgFXLv3gstiaq0GbnwRjbLm6Lgg41jX1gVPrs/PJ4z80ahg5Lfxef+CEW4kWYAI1nUrHsqde76ga0Zr7niVkrAf2baqHV+DUDMlSBKFAM6TDllwp8BjEbcKCzIGIJWVoImEmTIqmSEz6whfcKX5VENLS0HXa9Yq6W2rDneMcimTAq6HrWLNuPZwWIbLLyBigB3S3qkwXU5V2C9IQSYltOrjEjr90ojSWWOj18uULgchugTcwP0DGVykEGqrtTJzRGVQQcPObkLnep2j8bU1PsPq7OTseWInqJILAXUASf89CD+0ZBqUZO0+ZLasGZU8fIcqDHogX6LCfiQ3Rj1GyDlqQb1DogcSSuVJsClrKX0+8BD9Jr9OwQKIAx918JTRmXUVD7RHY1QScZnFX3KiCYk+Rogpg/teDRB2XGe3GqNvuH7iS0+O8p4jEmtrSKKesuZ4Z+/G6W/HPQLNkZvkZvRhL8S2yVhLHgBDgy+8qhNcurxW3cVpF+V8d5XzvH7Ggib/2xy0nXsdL0YJyCDJUwmG8MSGXC6/hWBBhuh/KIFszWBUwXHxQGpn5w68b6MeEXye2pYcpQI+5/EDbcD2On/fTyZDcnZyRjY02jh+6HTuKchc9FCA97lQbRf7jeyo0dUw9O3JyXNSfuJaydwUwDnr/itepiysGc1Gv6lMWAnfxucfXJTKQMcBl6nlJu0kbW7D8VP/w+CiPxlcf/x8ORpdj5AGFXjP599h5H2suDk0sdmNrQYCV/rFgyWDgfjgogjRgdw6aAJ8CXS9PfZzFzrEdFradGWEaVP7PX8PIdlEv/HwdbgcH7qqTG5YCJgnFUpSHeYc7aVmZzfxSpjG+VyZ+TbQ1kGCWi9Syl4mUwbIa73mRnK38RnMArSt4dDsAT9+eYkfY3ALcD+48YMb/2NuJAiE0krao7X1CYIcx4LtwS647EK+E+KpnUiDc9KKRrxY0DKE2ve6KF5MmytqIWHxDEFDZ2UU6WF9h5pEdCosk6p+rX6HZT+i5du79vIYeZfZ0BbawpWnl5RRhTZK4BKQzYZXuPpnpz8cdLLAQbKErUGS/nBAHmBZkPTse/mq7xkRXDIs3AJcYOQn8uZJaSm4k8cF6eOWhAMbQ7plbOpHPKohDgTgoEPenvxMBh/HN1dXg/PB5cfJ5/H59fAyDwnYWUa7UfByw9O90W0LbwxwZlPgTTH35oFzbWOKhjKKBcqbT4u3xclzKqt52anBJUgbsR1fnBJJV5525mA2M0V/OGjNZFXUQXUyH4iNoY6BvBlPLoeM/PphcsWIBGGr2nqQ2CDKY0ZqVYNWBkgGkrKGkZnS0JlylMpp9uk1Uihfgu7ttHURKpoWzUVq0U19Nzmg7ACNe0hcMxrAVf56hj1fCfgbwW6S6nAjO8KazDu8qmolAAmzs4tcdAoCd8uvmn5ZI1YfyVZx09KJqe80GWqNfTswHNRxtTuy/vk3iYZN2Ka6tebKYNJinhxyQ7hFqiG6TrESXKajJbeFO0ZL7B29W7paYUlvnF6v8fVjBIcMv2MUh2vslIngbMNUJP8DLDH8HExnskwta8F1zPw+OIvXbLMjX4a/KnvXam/D6/GEMjptPrtU6Wyljj/hJxn+RHuUMpq7d2o36d2Kam7mMR2RNOvE318yyWCS
api: eJztWEtvGzcQ/isEL44LamW76UU3xY9GbRoLkhwUMIyAIkda2lxyzYccQdB/L4ZcSSvZTWK06KXRSbsczvP7hpxd0cDnnvZu6Xn/glzX4HhQ1nh6x6gEL5yq8Zn26CgaTzjxysw1EJS2G2kyXRIVPJlFrZedx8i1mimQREkwAf+6gjLq4DGCD++sXNLeKj0qB5L2govAqLAmgAm4xOtaK5FUd+89Wl9RL0qoOP4Lyxpoj9rpPYhAGa0dOhIUeFzdOtUS9cEpM6eMVsp8ADMPJe2dHsZ3deD8foS7UMgbKOYFObJChMKXvAZfeKuVLIQDHuCd/XLEyFHFjZpZLYvaqUoFtQBfiDgFXLv3gstiaq0GbnwRjbLm6Lgg41jX1gVPrs/PJ4z80ahg5Lfxef+CEW4kWYAI1nUrHsqde76ga0Zr7niVkrAf2baqHV+DUDMlSBKFAM6TDllwp8BjEbcKCzIGIJWVoImEmTIqmSEz6whfcKX5VENLS0HXa9Yq6W2rDneMcimTAq6HrWLNuPZwWIbLLyBigB3S3qkwXU5V2C9IQSYltOrjEjr90ojSWWOj18uULgchugTcwP0DGVykEGqrtTJzRGVQQcPObkLnep2j8bU1PsPq7OTseWInqJILAXUASf89CD+0ZBqUZO0+ZLasGZU8fIcqDHogX6LCfiQ3Rj1GyDlqQb1DogcSSuVJsClrKX0+8BD9Jr9OwQKIAx918JTRmXUVD7RHY1QScZnFX3KiCYk+Rogpg/teDRB2XGe3GqNvuH7iS0+O8p4jEmtrSKKesuZ4Z+/G6W/HPQLNkZvkZvRhL8S2yVhLHgBDgy+8qhNcurxW3cVpF+V8d5XzvH7Ggib/2xy0nXsdL0YJyCDJUwmG8MSGXC6/hWBBhuh/KIFszWBUwXHxQGpn5w68b6MeEXye2pYcpQI+5/EDbcD2On/fTyZDcnZyRjY02jh+6HTuKchc9FCA97lQbRf7jeyo0dUw9O3JyXNSfuJaydwUwDnr/itepiysGc1Gv6lMWAnfxucfXJTKQMcBl6nlJu0kbW7D8VP/w+CiPxlcf/x8ORpdj5AGFXjP599h5H2suDk0sdmNrQYCV/rFgyWDgfjgogjRgdw6aAJ8CXS9PfZzFzrEdFradGWEaVP7PX8PIdlEv/HwdbgcH7qqTG5YCJgnFUpSHeYc7aVmZzfxSpjG+VyZ+TbQ1kGCWi9Syl4mUwbIa73mRnK38RnMArSt4dDsAT9+eYkfY3ALcD+48YMb/2NuJAiE0krao7X1CYIcx4LtwS647EK+E+KpnUiDc9KKRrxY0DKE2ve6KF5MmytqIWHxDEFDZ2UU6WF9h5pEdCosk6p+rX6HZT+i5du79vIYeZfZ0BbawpWnl5RRhTZK4BKQzYZXuPpnpz8cdLLAQbKErUGS/nBAHmBZkPTse/mq7xkRXDIs3AJcYOQn8uZJaSm4k8cF6eOWhAMbQ7plbOpHPKohDgTgoEPenvxMBh/HN1dXg/PB5cfJ5/H59fAyDwnYWUa7UfByw9O90W0LbwxwZlPgTTH35oFzbWOKhjKKBcqbT4u3xelzKqt52anBJUgbsR1fnBJJV5525mA2M0V/OGjNZFXUQXUyH4iNoY6BvBlPLoeM/PphcsWIBGGr2nqQ2CDKY0ZqVYNWBkgGkrKGkZnS0JlylMpp9uk1Uihfgu7ttHURKpoWzUVq0U19Nzmg7ACNe0hcMxrAVf56hj1fCfgbwW6S6nAjO8KazDu8qmolAAmzs4tcdAoCd8uvmn5ZI1YfyVZx09KJqe80GWqNfTswHNRxtTuy/vk3iYZN2Ka6tebKYNJinhxyQ7hFqiG6EFCCy3S05LZwx2iJvaN3S1crLOmN0+s1vn6M4JDhd4zicI2dMhGcbZiK5H+AJYafg+lMlqllLbiOmd8HZ/GabXbky/BXZe9a7W14PZ5QRqfNZ5cqna3U8Sf8JMOfaI9SRnP3Tu0mvVtRzc08piOSZp34+ws2HmCT
sidebar_class_name: "post api-method"
info_path: api/open/bitbybit-cad-cloud-api
custom_edit_url: null
Expand Down Expand Up @@ -64,38 +64,5 @@ Runs a single CAD operation by its fully-qualified identifier.

</StatusCodes>

{/* static-reference:generated */}

## Reference

`POST /api/v1/cad/execute`

Runs a single CAD operation by its fully-qualified identifier.

### Request body

Content type: `application/json` (required)

| Field | Type | Required | Description |
|---|---|---|---|
| `operation` | string | yes | Fully-qualified CAD operation identifier (e.g. 'occt.shapes.solid.createBox', 'manifold.primitives.cube', 'jscad.booleans.union'). Supports OCCT, Manifold, JSCAD, and vector/math operations. |
| `params` | object | no | Operation-specific parameters - varies by operation. See model definitions for available parameters. |

### Responses

| Status | Description |
|---|---|
| `202` | Task accepted |
| `400` | Validation error |
| `500` | Server error |

### Example request

```bash
curl -X POST "https://api.bitbybit.dev/api/v1/cad/execute" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'
```

Authentication: send your key in the `x-api-key` header. The full machine-readable specification is at [openapi.json](https://learn.bitbybit.dev/openapi.json).

Loading
Loading