Authentication and availability

Use a personal Gradient Dynamics API key or a supported OAuth connection to the central service. Studio’s authenticated session delegates engineering work through the same API. A customer’s credential is never a compute-provider credential.

REST authentication

Send Authorization: Bearer <key> over HTTPS. Keep the key in an environment variable or secret store; never include it in a document, committed script, URL or agent prompt. Examples use GD_API_KEY without printing its value.

export GD_API_BASE=https://api.gradient-dynamics.com
# Set GD_API_KEY securely in your shell or secret manager.
curl --fail-with-body --silent --show-error \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/capabilities"

Scope permissions and project access are both enforced. Having meshes:write does not grant access to another user’s geometry. Owner/admin operations and application-session operations have further checks. Consult each REST endpoint or MCP tool.

Connection setup

Retrieve your personal key through Studio’s Developer settings where available. OAuth-capable clients can use the service’s sign-in flow when enabled. Revoking a key, losing membership or changing project access can stop subsequent operations and access to saved views. Reconnect clients after rotating credentials.

Anonymous discovery can be enabled for selected tools; do not assume it is available in every environment. Mutation and private resource access require authentication. Client connection recipes are in MCP.

What availability means

The documentation describes the checked-in public contract, not a guarantee that every environment has every capability enabled. Discover the connected service’s capabilities and templates before selecting a workflow. A successful request-schema check does not prove that a geometry is meshable or that a simulation is physically well posed.

Native implementation features are not automatically public API features. Use only the controls accepted by the connected API. Optional account, inference, export and application integrations may be unavailable; report the returned reason rather than silently substituting another operation.

The Python distribution is not yet advertised as a published PyPI package. REST and MCP do not require installation of a Gradient Dynamics package. See Python client availability.