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"

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

artifact_id

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"

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

artifact_id

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"

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

artifact_id

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"

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.

MCP: inspect_mesh_geometry

Parameter

Location

Required

Type / values

artifact_id

path

Yes

string (uuid)

input_unit

query

No

"auto" / "mm" / "cm" / "m" / "in" or null

detail

query

No

"components" / "bounds"

engineering_context

query

No

string or null

expected_length_mm

query

No

number or null

Prefer

header

No

"respond-async"

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"

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

artifact_id

path

Yes

string (uuid)

Prefer

header

No

"respond-async"

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"

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

project_id

query

Yes

string (uuid)

job_id

query

No

string (uuid) or null

kind

query

No

"surface" / "geometry_surface" / "geometry_step" / "geometry_design" / "geometry_preview" / "mesh_cgns" / "mesh_openfoam" / "mesh_summary" / "simulation_result" / "restart" / "prediction_summary" / "prediction_fields" / "design_source" / "design_brief" / "mesh_section" / "mesh_section_image" / "mesh_section_html" / "engineering_view" / "engineering_view_html" / "cad_reconstruction" / "cad_reconstruction_preview" / "cad_reconstruction_report" / "cad_reconstruction_surface" / "convergence_chart" or null

limit

query

No

integer

after

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"

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.

MCP: read_artifact_summary

Parameter

Location

Required

Type / values

artifact_id

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"

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

artifact_id

path

Yes

string (uuid)

Prefer

header

No

"respond-async"

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"

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

artifact_id

path

Yes

string (uuid)

Prefer

header

No

"respond-async"

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"

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

artifact_id

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"

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

artifact_id

path

Yes

string (uuid)

Prefer

header

No

"respond-async"

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"

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.

MCP: view_simulation_result

Parameter

Location

Required

Type / values

artifact_id

path

Yes

string (uuid)

Prefer

header

No

"respond-async"

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"

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"

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"

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

Prefer

header

No

"respond-async"

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"

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

artifact_id

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"

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.

MCP: get_artifact_download

Parameter

Location

Required

Type / values

artifact_id

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"

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.