Simulations endpoints¶
Generated from the central API contract. Availability and permissions are checked by the connected service.
POST /v1/simulations¶
Simulation
Authorization: simulations:write Current resource access and role checks also apply.
MCP: run_simulation
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
header |
No |
string or null |
|
header |
No |
string or null |
Request body: application/json — SimulationRequest. 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 "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/simulations"
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/simulations/controls¶
Solver Controls
Authorization: simulations:write Current resource access and role checks also apply.
MCP: get_solver_controls
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
query |
No |
string |
|
query |
No |
|
|
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/simulations/controls"
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/simulations/guidance¶
Simulation Guidance
Authorization: simulations:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
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/simulations/guidance"
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/simulations/validate¶
Validate Simulation
Authorization: simulations:write Current resource access and role checks also apply.
MCP: validate_simulation
Request body: application/json — SimulationRequest. 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/simulations/validate"
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.