Skip to content
POST/api/v1/compliance/export

Export compliance audit package

Generates an audit package for a framework (gap report + remediation plan) and returns it as HTML/markdown/pdf (downloadable text) or structured JSON. Synchronous — no job is queued.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "framework": "<india-dpdp-act | hipaa (legacy enhanced->",
  "format": "html",
  "organizationName": "string",
  "systemName": "string",
  "systemVersion": "string",
  "systemDescription": "string",
  "assessorName": "string",
  "scope": "string",
  "useCase": "string",
  "dataTypes": [
    "string"
  ],
  "includeModelCard": false,
  "includeRemediationPlan": false,
  "includeEvidenceLog": false
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "framework": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120,
          "description": "india-dpdp-act | hipaa (legacy enhanced-shape frameworks)."
        },
        "format": {
          "type": "string",
          "enum": [
            "html",
            "json",
            "markdown",
            "pdf"
          ]
        },
        "organizationName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "systemName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "systemVersion": {
          "type": "string",
          "maxLength": 120
        },
        "systemDescription": {
          "type": "string",
          "maxLength": 20000
        },
        "assessorName": {
          "type": "string",
          "maxLength": 500
        },
        "scope": {
          "type": "string",
          "maxLength": 2000
        },
        "scanResults": {
          "description": "Optional SecurityScanResult for gap analysis."
        },
        "useCase": {
          "type": "string",
          "maxLength": 2000
        },
        "dataTypes": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        },
        "includeModelCard": {
          "type": "boolean"
        },
        "includeRemediationPlan": {
          "type": "boolean"
        },
        "includeEvidenceLog": {
          "type": "boolean"
        }
      },
      "required": [
        "framework",
        "organizationName",
        "systemName"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Audit package — text (html/markdown/pdf) or JSON.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/compliance/export \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "framework": "<india-dpdp-act | hipaa (legacy enhanced->", "format": "html", "organizationName": "string", "systemName": "string", "systemVersion": "string", "systemDescription": "string", "assessorName": "string", "scope": "string", "useCase": "string", "dataTypes": [ "string" ], "includeModelCard": false, "includeRemediationPlan": false, "includeEvidenceLog": false }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/compliance/export", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "framework": "<india-dpdp-act | hipaa (legacy enhanced->",
    "format": "html",
    "organizationName": "string",
    "systemName": "string",
    "systemVersion": "string",
    "systemDescription": "string",
    "assessorName": "string",
    "scope": "string",
    "useCase": "string",
    "dataTypes": [
      "string"
    ],
    "includeModelCard": false,
    "includeRemediationPlan": false,
    "includeEvidenceLog": false
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/compliance/export",
    headers=headers,
    json={
    "framework": "<india-dpdp-act | hipaa (legacy enhanced->",
    "format": "html",
    "organizationName": "string",
    "systemName": "string",
    "systemVersion": "string",
    "systemDescription": "string",
    "assessorName": "string",
    "scope": "string",
    "useCase": "string",
    "dataTypes": [
        "string"
    ],
    "includeModelCard": False,
    "includeRemediationPlan": False,
    "includeEvidenceLog": False
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"framework":"<india-dpdp-act | hipaa (legacy enhanced->","format":"html","organizationName":"string","systemName":"string","systemVersion":"string","systemDescription":"string","assessorName":"string","scope":"string","useCase":"string","dataTypes":["string"],"includeModelCard":false,"includeRemediationPlan":false,"includeEvidenceLog":false}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/compliance/export", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Compliance endpoints