Jobs endpoints¶
Generated from the central API contract. Availability and permissions are checked by the connected service.
GET /v1/jobs¶
List your jobs across credentials, or filter an accessible project
Authorization: jobs:read Current resource access and role checks also apply.
MCP: list_jobs
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
query |
No |
string (uuid) or null |
|
query |
No |
|
|
query |
No |
integer |
|
query |
No |
string |
|
query |
No |
|
|
query |
No |
|
|
query |
No |
|
|
query |
No |
|
|
query |
No |
string or null |
|
query |
No |
string (uuid) or null |
|
query |
No |
number or null |
|
query |
No |
number or null |
|
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/jobs"
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/jobs/{job_id}¶
Get Job
Authorization: jobs:read Current resource access and role checks also apply.
MCP: get_job
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/jobs/REPLACE_JOB_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.
PATCH /v1/jobs/{job_id}¶
Rename a job without changing its request or starting compute
Authorization: jobs:cancel Current resource access and role checks also apply.
MCP: rename_job
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
Request body: application/json — JobRename. 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 PATCH \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/jobs/REPLACE_JOB_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.
DELETE /v1/jobs/{job_id}¶
Remove a finished job from the workspace; retain artifacts and billing history
Authorization: jobs:cancel Current resource access and role checks also apply.
MCP: delete_job
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 DELETE \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/jobs/REPLACE_JOB_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/jobs/{job_id}/events¶
Events
Authorization: jobs:read Current resource access and role checks also apply.
MCP: get_job_events
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
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/jobs/REPLACE_JOB_ID/events"
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/jobs/{job_id}/review¶
Accept or discard a verified mesh candidate without starting compute
Authorization: meshes:write Current resource access and role checks also apply.
MCP: review_job
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
Request body: application/json — JobReview. 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/jobs/REPLACE_JOB_ID/review"
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.
POST /v1/jobs/{job_id}/cancel¶
Cancel Job
Authorization: jobs:cancel Current resource access and role checks also apply.
MCP: cancel_job
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/jobs/REPLACE_JOB_ID/cancel"
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/jobs/{job_id}/request¶
Job Request
Authorization: jobs:read Current resource access and role checks also apply.
MCP: get_job_request
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/jobs/REPLACE_JOB_ID/request"
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/jobs/{job_id}/convergence¶
Judge a finished simulation’s convergence with chosen criteria, without changing it
Authorization: jobs:read Current resource access and role checks also apply.
MCP: assess_convergence
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
Request body: application/json — ConvergenceCriteria or null. Optional.
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/jobs/REPLACE_JOB_ID/convergence"
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/jobs/{job_id}/viewer¶
Prepare or reopen this job’s default browser view without repeating compute
Authorization: jobs:read Current resource access and role checks also apply.
MCP: prepare_job_viewer
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
query |
No |
boolean |
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/jobs/REPLACE_JOB_ID/viewer"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Browser view preparation is queued or running. Poll status_url or get_operation using operation_id; no viewer_url is returned until ready. |
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/jobs/{job_id}/convergence-chart¶
Open a finished simulation’s residual and force history in the browser
Authorization: jobs: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/jobs/REPLACE_JOB_ID/convergence-chart"
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.