Skip to main content
Base URL: https://api-sim.hardlightsim.com Base path: /v0 Auth: Authorization: Bearer <hls_live_service_key>

Core Endpoints

  • POST /v0/jobs create simulation job.
  • POST /v0/inputs/presign-upload generate presigned upload URL for local input files.
  • GET /v0/jobs/{job_id} fetch status + artifacts.
  • GET /v0/jobs list jobs for authenticated customer.
  • POST /v0/jobs/{job_id}/cancel request cancellation.
  • GET /v0/jobs/{job_id}/artifacts/{name}/download-url fetch presigned URL.

Submit Response Billing Fields

POST /v0/jobs includes:
  • estimated_credits
  • estimated_usd
  • billing_model
  • billing_price_id
  • gpu_hourly_rate_usd
These values are estimates at submit time. Final debit is settled at terminal state from runtime usage.

Error Types You Should Handle

  • 402 insufficient credits / billing guardrail.
  • 403 plan not entitled.
  • 404 cross-tenant or unknown job.
  • 409 idempotency conflict.
  • 429 tenant guardrail exceeded.

Full Contract

See repository spec: docs/api-v0-spec.md.