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"
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/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 |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
query |
No |
integer |
|
query |
No |
integer |
|
query |
No |
|
|
query |
No |
integer |
|
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"
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/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 |
|---|---|---|---|
|
query |
Yes |
string (uuid) |
|
query |
Yes |
string |
|
query |
Yes |
|
|
header |
Yes |
string |
|
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 |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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"
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/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 |
|---|---|---|---|
|
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"
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/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"
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/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"
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/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"
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/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"
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/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 |
|---|---|---|---|
|
header |
No |
|
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"
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/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"
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/design/drafts¶
Listing
Authorization: geometry:read Current resource access and role checks also apply.
MCP: list_design_drafts
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
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"
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/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 |
|---|---|---|---|
|
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"
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/design/drafts/{draft_id}/checkpoints/{sequence}¶
Checkpoint
Authorization: geometry:read Current resource access and role checks also apply.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
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"
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/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 |
|---|---|---|---|
|
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"
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/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 |
|---|---|---|---|
|
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"
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/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 |
|---|---|---|---|
|
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"
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/design/brief-intent¶
Brief Intent
Authorization: geometry:write Current resource access and role checks also apply.
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"
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.