Artifacts endpoints¶
Generated from the central API contract. Availability and permissions are checked by the connected service.
POST /v1/artifacts/uploads¶
Create Upload
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Request body: application/json — UploadCreate. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/uploads"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/complete¶
Complete Upload
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: complete_surface_upload, complete_design_source_upload
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/complete"
HTTP status |
Response schema |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}¶
Artifact
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: get_artifact
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID"
HTTP status |
Response schema |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}/download¶
Download
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/download"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}/mesh-profile¶
Inspect Mesh Geometry
Authorization: meshes:write Current resource access and role checks also apply.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
query |
No |
|
|
query |
No |
|
|
query |
No |
string or null |
|
query |
No |
number or null |
|
header |
No |
|
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/mesh-profile"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}/geometry-check¶
Check Geometry
Authorization: meshes:write Current resource access and role checks also apply.
MCP: check_geometry
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
header |
No |
|
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/geometry-check"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts¶
List Artifacts
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: list_artifacts
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
query |
Yes |
string (uuid) |
|
query |
No |
string (uuid) or null |
|
query |
No |
|
|
query |
No |
integer |
|
query |
No |
string |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts?project_id=REPLACE_PROJECT_ID"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}/summary¶
Artifact Summary
Authorization: artifacts:read Current resource access and role checks also apply.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/summary"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/artifacts/{artifact_id}/preview¶
Issue Preview
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: view_geometry
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
header |
No |
|
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/preview"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/mesh-section¶
View Mesh Section
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: view_mesh_section
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
header |
No |
|
Request body: application/json — MeshSectionOptions. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/mesh-section"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/mesh-section/data¶
Live Section
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
Request body: application/json — MeshSectionOptions. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/mesh-section/data"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/mesh-view¶
View Mesh
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: view_mesh
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
header |
No |
|
Request body: application/json — MeshViewOptions. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/mesh-view"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/simulation-view¶
View Simulation Result
Authorization: artifacts:read Current resource access and role checks also apply.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
header |
No |
|
Request body: application/json — SimulationViewOptions. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/simulation-view"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/browser-uploads¶
Open Surface
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: open_surface_upload, prepare_surface_upload
Request body: application/json — BrowserUpload. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/browser-uploads"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/direct-uploads¶
Open Direct
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: create_upload
Request body: application/json — BrowserUpload. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/direct-uploads"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/attachment-imports¶
Import Surface
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: import_surface_attachment
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
header |
No |
|
Request body: application/json — AttachmentSurfaceImport. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/attachment-imports"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/cad-reconstruction¶
Reconstruct
Authorization: geometry:write Current resource access and role checks also apply.
MCP: reconstruct_cad
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
Request body: application/json — ReconstructionOptions. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/cad-reconstruction"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/artifacts/{artifact_id}/browser-download¶
Open Download
Authorization: artifacts:read Current resource access and role checks also apply.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/artifacts/REPLACE_ARTIFACT_ID/browser-download"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.