Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Gradient Dynamics Documentation
Logo
  • Getting Started
    • How Gradient Dynamics fits together
    • Complete a first engineering workflow
    • Organize a project
    • Engineering workflow
      • Platform overview
      • The simulation workflow
      • Choosing physics and fidelity
      • Meshes and resolution
      • Results, convergence and validation
      • Supported formats
      • Plans, credits and limits
      • Keyboard shortcuts
  • Studio
    • Work in Studio
    • Workspace tour
    • Projects, revisions and collaboration
    • Prepare a design for engineering work
    • Shared authoring with agents
    • Mesh in Studio
    • Configure Fluxcore in Studio
    • Jobs and activity
    • Review results in Studio
    • Usage, estimates and saved data
  • Implicit Modelling
    • Bodies, fields and feature graphs
    • Create your first implicit body
    • Create and combine bodies
    • Design with fields
    • Lattices and graded structures
    • Parameters, references and reusable functions
    • Validate geometry and manufacturing constraints
    • Name physical bodies and simulation regions
    • Import, export and fidelity
    • Implicit modelling for agents
    • Feature operation reference
      • Boolean operations
      • Create operations
      • Field operations
      • Lattice operations
      • Math operations
      • Measure operations
      • Model operations
      • Primitive operations
  • Meshing
    • GD Structured Meshing
    • GD Hex-core Meshing
    • Prepare and inspect geometry
    • Set up the flow domain
    • Choose mesh settings
    • Named surfaces and geometry fidelity
    • Refine where the physics needs resolution
    • Boundary-layer resolution
    • Multi-region and CHT meshing
    • Region interfaces
    • Review mesh quality and acceptance
    • Mesh outputs and export formats
  • Fluxcore
    • Fluxcore approach and capabilities
    • The five primitives and residuals
    • Prepare a simulation
    • Boundary conditions
    • Laminar, RANS and hybrid turbulence models
    • Solver controls
    • Time-accurate simulations and restart
    • Conjugate heat transfer
    • Rotating regions and walls
    • Submit and monitor a run
    • Convergence and result qualification
    • Inspect and compare results
  • API/MCP
    • Authentication and availability
    • REST quickstart
    • Agent workflow
    • Projects, workflows and artifacts
    • Uploads and downloads
    • Units and coordinates
    • Implicit geometry and CAD
    • Design operation reference
    • Meshing requests
    • Fluxcore requests
    • Thermal request example
    • Rotating-region request example
    • Turbulence and hybrid models
    • Time integration and restart
    • Advanced controls
    • Spatial accuracy
    • Linear convergence controls
    • Output controls
    • Jobs, operations and recovery
    • Results and visualization
    • Studies and predictions
    • Errors and limits
    • Python client
    • MCP server
      • Complete tool catalogue
        • search_tools
        • get_tool_schema
        • get_capabilities
        • list_projects
        • create_project
        • import_surface_attachment
        • create_upload
        • open_surface_upload
        • prepare_surface_upload
        • complete_surface_upload
        • view_geometry
        • inspect_mesh_geometry
        • check_geometry
        • plan_mesh
        • validate_mesh
        • create_mesh
        • get_mesh_controls
        • validate_simulation
        • run_simulation
        • get_solver_controls
        • estimate_cost
        • get_job
        • list_jobs
        • list_activity
        • get_job_events
        • get_operation
        • cancel_job
        • review_job
        • prepare_job_viewer
        • view_mesh
        • view_mesh_section
        • view_simulation_result
        • list_artifacts
        • get_artifact
        • read_artifact_summary
        • get_artifact_download
        • list_templates
        • get_template
        • create_geometry
        • create_design_preview
        • get_design_preview
        • list_design_drafts
        • get_design_draft
        • publish_design_batch
        • finish_design_draft
        • get_design_checkpoint
        • interpret_design_brief
        • reconstruct_cad
        • edit_reconstructed_cad
        • get_cad_reconstruction
        • get_design_operation_schema
        • call_design_operation
        • prepare_cold_plate_simulation
        • import_design_source_attachment
        • open_design_source_upload
        • prepare_design_source_upload
        • complete_design_source_upload
        • read_design_source
        • create_design_brief
        • get_design_brief
        • plan_cold_plate
        • compare_cold_plate_candidates
        • get_request_schema
        • validate_geometry
        • plan_geometry_study
        • submit_study
        • list_models
        • validate_prediction
        • predict_physics
        • get_activity
        • get_workflow
        • cancel_operation
        • get_job_request
        • assess_convergence
        • delete_job
        • rename_job
        • assemble_mesh_viewer
        • view_convergence_history
        • assemble_simulation_viewer
        • get_billing
        • create_topup_link
        • get_account
        • get_usage
        • get_audit_log
      • Connection guides
        • Connect Claude to Gradient Dynamics
        • Connect Cursor to Gradient Dynamics
        • Connect Codex or ChatGPT
        • Scripts and CI
        • Cold-plate agent quickstart
        • MCP tools
        • Engineering data and access
    • REST endpoints and models
      • Account endpoints
      • Activity endpoints
      • Agent endpoints
      • Artifacts endpoints
      • Billing endpoints
      • Cad endpoints
      • Capabilities endpoints
      • Design endpoints
      • Estimates endpoints
      • Geometries endpoints
      • Geometry endpoints
      • Jobs endpoints
      • Keys endpoints
      • Mcp endpoints
      • Me endpoints
      • Meshes endpoints
      • Models endpoints
      • Notifications endpoints
      • Operations endpoints
      • Organization endpoints
      • Predictions endpoints
      • Projects endpoints
      • Service endpoints
      • Simulations endpoints
      • Studies endpoints
      • Usage endpoints
      • Visualizations endpoints
      • Webhooks endpoints
      • Workflows endpoints
      • Request and response models
        • ArtifactResponse
        • AttachmentSourceImport
        • AttachmentSurfaceImport
        • AuthorTask
        • BoundaryCondition
        • BoundaryValue
        • BriefCreate
        • BriefIntentRequest
        • BriefIntentResponse
        • BrowserSourceUpload
        • BrowserUpload
        • Candidate
        • CandidateEvidence
        • ChatAttachment
        • CheckoutReturn
        • ChtPort
        • Citation
        • Clarification
        • ColdPlatePlan
        • CompareCandidates
        • Confirmation
        • Context
        • ContextLimitation
        • ConvergenceCriteria
        • Create
        • CreditAmount
        • CycleChange
        • Decision
        • DecisionContext
        • DesignConstraint
        • DesignDocument
        • DesignInput
        • DocumentRequest
        • DraftBatch
        • DraftCreate
        • DraftDecision
        • DraftRun
        • DraftState
        • EditRequest
        • ElectronicsConditions
        • ErrorResponse
        • EstimateRequest
        • EvaluateRequest
        • ExportRequest
        • Feature
        • FlowRegion
        • Fluid
        • FluxCoreConfig
        • ForcesConfig
        • FunctionDefinition
        • Generation
        • GeometryRequest
        • GraphEdit
        • HTTPValidationError
        • HeatMapPlacement
        • ImportRequest
        • InputLimit
        • InputSource
        • Invitation
        • JobError
        • JobPage
        • JobQueue
        • JobRename
        • JobResponse
        • JobReview
        • JsonValue
        • KeyCreate
        • KeyUpdate
        • LiveRequest
        • MCP_create_design_brief_Metric
        • MCP_create_design_brief_OperatingPoint
        • MCP_create_mesh_Clarification
        • MCP_create_mesh_DecisionContext
        • MCP_create_mesh_FlowRegion
        • MCP_create_mesh_MeshMRFZone
        • MCP_create_mesh_OctreeBoundaryLayer
        • MCP_create_mesh_OctreeDomain
        • MCP_create_mesh_OctreeFlow
        • MCP_create_mesh_OctreePartWake
        • MCP_create_mesh_OctreePrismOptions
        • MCP_create_mesh_OctreeRefinementShape
        • MCP_create_mesh_OctreeRegion
        • MCP_create_mesh_OctreeRotatingZone
        • MCP_create_mesh_OctreeSurface
        • MCP_create_mesh_OctreeSurfaceOverride
        • MCP_create_mesh_OctreeVolume
        • MCP_create_mesh_OctreeWake
        • MCP_create_mesh_OpenFoamOptions
        • MCP_create_mesh_OpenFoamRefinementRegion
        • MCP_create_mesh_StructuredOptions
        • MCP_plan_geometry_study_GeometryRequest
        • MCP_plan_mesh_Clarification
        • MCP_plan_mesh_DecisionContext
        • MCP_plan_mesh_FlowRegion
        • MCP_plan_mesh_MeshMRFZone
        • MCP_plan_mesh_OctreeBoundaryLayer
        • MCP_plan_mesh_OctreeDomain
        • MCP_plan_mesh_OctreeFlow
        • MCP_plan_mesh_OctreePartWake
        • MCP_plan_mesh_OctreePrismOptions
        • MCP_plan_mesh_OctreeRefinementShape
        • MCP_plan_mesh_OctreeRegion
        • MCP_plan_mesh_OctreeRotatingZone
        • MCP_plan_mesh_OctreeSurface
        • MCP_plan_mesh_OctreeSurfaceOverride
        • MCP_plan_mesh_OctreeVolume
        • MCP_plan_mesh_OctreeWake
        • MCP_plan_mesh_OpenFoamOptions
        • MCP_plan_mesh_OpenFoamRefinementRegion
        • MCP_plan_mesh_StructuredOptions
        • MCP_prepare_cold_plate_simulation_BoundaryValue
        • MCP_prepare_cold_plate_simulation_Clarification
        • MCP_prepare_cold_plate_simulation_ConvergenceCriteria
        • MCP_prepare_cold_plate_simulation_DecisionContext
        • MCP_prepare_cold_plate_simulation_FluxCoreConfig
        • MCP_prepare_cold_plate_simulation_ForcesConfig
        • MCP_prepare_cold_plate_simulation_MRFZone
        • MCP_prepare_cold_plate_simulation_NumericalControls
        • MCP_prepare_cold_plate_simulation_SimulationRequest
        • MCP_prepare_cold_plate_simulation_ThermalConfig
        • MCP_run_simulation_BoundaryValue
        • MCP_run_simulation_Clarification
        • MCP_run_simulation_ConvergenceCriteria
        • MCP_run_simulation_DecisionContext
        • MCP_run_simulation_FluxCoreConfig
        • MCP_run_simulation_ForcesConfig
        • MCP_run_simulation_MRFZone
        • MCP_run_simulation_NumericalControls
        • MCP_run_simulation_ThermalConfig
        • MCP_validate_mesh_Clarification
        • MCP_validate_mesh_DecisionContext
        • MCP_validate_mesh_FlowRegion
        • MCP_validate_mesh_MeshMRFZone
        • MCP_validate_mesh_OctreeBoundaryLayer
        • MCP_validate_mesh_OctreeDomain
        • MCP_validate_mesh_OctreeFlow
        • MCP_validate_mesh_OctreePartWake
        • MCP_validate_mesh_OctreePrismOptions
        • MCP_validate_mesh_OctreeRefinementShape
        • MCP_validate_mesh_OctreeRegion
        • MCP_validate_mesh_OctreeRotatingZone
        • MCP_validate_mesh_OctreeSurface
        • MCP_validate_mesh_OctreeSurfaceOverride
        • MCP_validate_mesh_OctreeVolume
        • MCP_validate_mesh_OctreeWake
        • MCP_validate_mesh_OpenFoamOptions
        • MCP_validate_mesh_OpenFoamRefinementRegion
        • MCP_validate_mesh_StructuredOptions
        • MCP_validate_simulation_BoundaryValue
        • MCP_validate_simulation_Clarification
        • MCP_validate_simulation_ConvergenceCriteria
        • MCP_validate_simulation_DecisionContext
        • MCP_validate_simulation_FluxCoreConfig
        • MCP_validate_simulation_ForcesConfig
        • MCP_validate_simulation_MRFZone
        • MCP_validate_simulation_NumericalControls
        • MCP_validate_simulation_ThermalConfig
        • MRFZone
        • Manufacturing
        • ManufacturingLimit
        • MeshMRFZone
        • MeshRequest
        • MeshRequirement
        • MeshSectionOptions
        • MeshUnitConversion
        • MeshViewOptions
        • MeshWorkspaceRequest
        • Message
        • Metric
        • ModelsRequest
        • NamedSurface
        • NumericalControls
        • OctreeBoundaryLayer
        • OctreeControls
        • OctreeDomain
        • OctreeFlow
        • OctreePartWake
        • OctreePrismOptions
        • OctreeRefinementShape
        • OctreeRegion
        • OctreeRotatingZone
        • OctreeSurface
        • OctreeSurfaceLayers
        • OctreeSurfaceOverride
        • OctreeVolume
        • OctreeWake
        • OpenFoamOptions
        • OpenFoamRefinementBox
        • OpenFoamRefinementRegion
        • OperatingPoint
        • OperationResponse
        • PackRequest
        • PaymentRequiredResponse
        • PlanCheckout
        • PredictRequest
        • PredictionRequest
        • Preferences
        • PrepareThermalSimulation
        • PreviewRequest
        • ProjectCreate
        • Promote
        • ReadThrough
        • ReconstructionEdit
        • ReconstructionOptions
        • RefinementWindow
        • RefusalActions
        • RequestError
        • Requirement
        • ResultWorkspaceRequest
        • RoleChange
        • SectionRequest
        • SimulationRequest
        • SimulationViewOptions
        • SourceReview
        • SourceUpload
        • SpendingLimit
        • StructuredOptions
        • StudyCase
        • StudyPlanRequest
        • StudyRequest
        • StudySubmit
        • StudyVariable
        • SurfaceHeatSource
        • ThermalConfig
        • ThermalRequest
        • TopUp
        • UploadCreate
        • ValidationError
    • Compatibility and migration
  • Tutorials
    • Implicit cylinder
    • Cold plate
    • Vehicle aerodynamics
    • Airfoil
    • Internal pipe flow
    • Rotating machinery
  • Release Notes
  • Knowledge Base
    • Validation studies
      • NACA 0012
      • Plate-fin heat sink
      • DrivAerML
      • Turbulent pipe flow
    • Best practices
    • Troubleshooting
    • Frequently asked questions
    • Glossary
Back to top

create_topup_link¶

Get a Stripe Checkout link to buy Developer credits (£10 each), for when a free trial or Developer account runs out (a 402 with insufficient_allowance).

Scope: billing:write. Catalogue annotation: Writes / prepares / submits work. Additional ownership and role checks may apply.

REST: POST /v1/billing/topups.

Arguments¶

Field

Type / accepted values

Required

Default

Constraints / meaning

credits

integer or null

No

null

minimum: 1; maximum: 100000; Credits to start with (Stripe’s page lets the payer change it).

Calling the tool¶

Use tools/call with this tool’s exact name and an arguments object matching the fields above. Get the complete live schema before supplying advanced controls:

{
  "name": "get_tool_schema",
  "arguments": {
    "name": "create_topup_link",
    "include_definitions": false
  }
}

Result and continuation¶

Inspect isError and structuredContent. Keep returned job, operation and artifact IDs. A pending operation_id is followed with get_operation; a compute job is followed with get_job. A wait timeout does not cancel work. Follow returned polling intervals and retain the same idempotency key when reconciling the same submission.

See agent workflow, jobs and operations, uploads, results and error recovery for the applicable lifecycle. MCP annotations describe tool behaviour; they are not blanket permission to run paid work or change account state.

Next
get_account
Previous
get_billing
Copyright © 2026, Gradient Dynamics Ltd.
Made with Furo
On this page
  • create_topup_link
    • Arguments
    • Calling the tool
    • Result and continuation