Docs/API Reference/REST API Schema
Documentation

REST API Reference

Integrate the EnvForage dependency matrix resolution logic directly into your custom CI/CD pipelines, DevOps tooling, or setup workflows.

POST/api/v1/compatibility/resolve(Resolves CUDA, Python, and package targets)

Live Interactive Endpoint Simulator

Simulated Request
curl -X POST "http://localhost:8000/api/v1/compatibility/resolve" \
  -H "Content-Type: application/json" \
  -d '{
    "os": "linux",
    "gpu_vendor": "nvidia",
    "driver_version": "535.104",
    "framework": "pytorch"
  }'
JSON Response (200 OK)
{
  "status": "success",
  "python_version": "3.10",
  "cuda_version": "12.1",
  "packages": [
    "torch==2.1.0+cu121",
    "torchvision==0.16.0+cu121",
    "torchaudio==2.1.0+cu121"
  ],
  "verification_status": "verified"
}

Request Body Parameters

ParameterTypeRequiredDescription
osstringYesTarget operating system. Allowed: linux, windows, macos
gpu_vendorstringYesGraphics processor driver set. E.g. nvidia, amd, cpu
driver_versionstringYesLocal graphic driver version identifier. E.g. "535.104", "525.60"
frameworkstringYesDesired ML framework stack. Allowed: pytorch, tensorflow, jax

HTTP Response Codes

CodeStatusDescription
200OKDependencies resolved successfully. Returns compatible packages configuration.
400Bad RequestQuery attributes could not be resolved or driver specifications are missing.
422Validation ErrorRequest payload contains invalid properties or fails data scheme validations.
500Internal ErrorResolution server experienced an issue or cannot query dependency db.
Did this guide help you? Reach out on GitHub.
Get EnvForage CLI