Design endpoints

Generated from the central API contract. Availability and permissions are checked by the connected service.

POST /v1/design/sources/uploads

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 — SourceUpload. 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/design/sources/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.

GET /v1/design/sources/{artifact_id}

Read

Authorization: artifacts:read Current resource access and role checks also apply.

MCP: read_design_source

Parameter

Location

Required

Type / values

artifact_id

path

Yes

string (uuid)

start_page

query

No

integer

page_count

query

No

integer

csv_mode

query

No

"heat_map" / "table"

start_row

query

No

integer

row_count

query

No

integer

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/design/sources/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.

POST /v1/design/sources/uploads/content

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.

Parameter

Location

Required

Type / values

project_id

query

Yes

string (uuid)

filename

query

Yes

string

media_type

query

Yes

"application/pdf" / "text/csv" / "text/plain" / "image/png" / "image/jpeg"

Idempotency-Key

header

Yes

string

X-Content-SHA256

header

Yes

string

Request body: application/pdf — string (binary). Required.

Request body: text/csv — string (binary). Required.

Request body: text/plain — string (binary). Required.

Request body: image/png — string (binary). Required.

Request body: image/jpeg — string (binary). Required.

Request body: application/octet-stream — string (binary). 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 "Idempotency-Key: REPLACE_IDEMPOTENCY_KEY" \
  -H "X-Content-SHA256: REPLACE_X_CONTENT_SHA256" \
  "$GD_API_BASE/v1/design/sources/uploads/content?project_id=REPLACE_PROJECT_ID&filename=REPLACE_FILENAME&media_type=REPLACE_MEDIA_TYPE"

HTTP status

Response schema

201

JSON

401

ErrorResponse

403

ErrorResponse

404

ErrorResponse

409

ErrorResponse

413

ErrorResponse

422

ErrorResponse

429

ErrorResponse

500

ErrorResponse

503

ErrorResponse

402

PaymentRequiredResponse

200

Verified replay of a reference upload

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/design/briefs

Create

Authorization: geometry:write Current resource access and role checks also apply.

MCP: create_design_brief

Request body: application/json — BriefCreate. 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/design/briefs"

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/design/briefs/{artifact_id}

Get

Authorization: artifacts:read Current resource access and role checks also apply.

MCP: get_design_brief

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/design/briefs/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.

POST /v1/design/cold-plates/plan

Plan

Authorization: geometry:write Current resource access and role checks also apply.

MCP: plan_cold_plate

Request body: application/json — ColdPlatePlan. 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/design/cold-plates/plan"

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/design/cold-plates/simulation-plan

Simulation Plan

Authorization: simulations:write Current resource access and role checks also apply.

MCP: prepare_cold_plate_simulation

Request body: application/json — PrepareThermalSimulation. 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/design/cold-plates/simulation-plan"

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/design/cold-plates/compare

Compare

Authorization: jobs:read Current resource access and role checks also apply.

MCP: compare_cold_plate_candidates

Request body: application/json — CompareCandidates. 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/design/cold-plates/compare"

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/design/sources/browser-uploads

Open Source

Authorization: artifacts:write Current resource access and role checks also apply.

MCP: open_design_source_upload, prepare_design_source_upload

Request body: application/json — BrowserSourceUpload. 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/design/sources/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/design/sources/attachment-imports

Import Source

Authorization: artifacts:write Current resource access and role checks also apply.

MCP: import_design_source_attachment

Parameter

Location

Required

Type / values

Prefer

header

No

"respond-async"

Request body: application/json — AttachmentSourceImport. 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/design/sources/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/design/drafts

Create

Authorization: geometry: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 — DraftCreate. 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/design/drafts"

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/design/drafts

Listing

Authorization: geometry:read Current resource access and role checks also apply.

MCP: list_design_drafts

Parameter

Location

Required

Type / values

project_id

query

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/design/drafts?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/design/drafts/{draft_id}

Get

Authorization: geometry:read Current resource access and role checks also apply.

MCP: get_design_draft

Parameter

Location

Required

Type / values

draft_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/design/drafts/REPLACE_DRAFT_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/design/drafts/{draft_id}/checkpoints/{sequence}

Checkpoint

Authorization: geometry:read Current resource access and role checks also apply.

MCP: get_design_checkpoint

Parameter

Location

Required

Type / values

draft_id

path

Yes

string (uuid)

sequence

path

Yes

integer

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/design/drafts/REPLACE_DRAFT_ID/checkpoints/REPLACE_SEQUENCE"

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/design/drafts/{draft_id}/batches

Batch

Authorization: geometry:write Current resource access and role checks also apply.

MCP: publish_design_batch

Parameter

Location

Required

Type / values

draft_id

path

Yes

string (uuid)

Request body: application/json — DraftBatch. 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/design/drafts/REPLACE_DRAFT_ID/batches"

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/design/drafts/{draft_id}/state

State

Authorization: geometry:write Current resource access and role checks also apply.

MCP: finish_design_draft

Parameter

Location

Required

Type / values

draft_id

path

Yes

string (uuid)

Request body: application/json — DraftState. 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/design/drafts/REPLACE_DRAFT_ID/state"

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/design/drafts/{draft_id}/run

Run

Authorization: geometry:write 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

draft_id

path

Yes

string (uuid)

Request body: application/json — DraftRun. 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/design/drafts/REPLACE_DRAFT_ID/run"

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/design/brief-intent

Brief Intent

Authorization: geometry:write Current resource access and role checks also apply.

MCP: interpret_design_brief

Request body: application/json — BriefIntentRequest. 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/design/brief-intent"

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.