POST/api/v1/data-cards

Create a Data Card

Creates a Data Card for a dataset. Used for EU AI Act + GDPR documentation requirements.

Authentication

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

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "datasetId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "version": "string",
  "motivation": "string",
  "composition": {},
  "collectionMethod": "string",
  "preprocessing": "string",
  "ethicalConsiderations": "string",
  "maintenancePlan": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "projectId",
        "name"
      ],
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid"
        },
        "datasetId": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "version": {
          "type": "string",
          "maxLength": 50
        },
        "motivation": {
          "type": "string"
        },
        "composition": {
          "type": "object"
        },
        "collectionMethod": {
          "type": "string"
        },
        "preprocessing": {
          "type": "string"
        },
        "ethicalConsiderations": {
          "type": "string"
        },
        "maintenancePlan": {
          "type": "string"
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Success.
400Invalid params.
403Cross-tenant denial.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/data-cards \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "datasetId": "00000000-0000-0000-0000-000000000000", "name": "string", "version": "string", "motivation": "string", "composition": {}, "collectionMethod": "string", "preprocessing": "string", "ethicalConsiderations": "string", "maintenancePlan": "string" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/data-cards",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "version": "string",
    "motivation": "string",
    "composition": {},
    "collectionMethod": "string",
    "preprocessing": "string",
    "ethicalConsiderations": "string",
    "maintenancePlan": "string"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/data-cards",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "version": "string",
    "motivation": "string",
    "composition": {},
    "collectionMethod": "string",
    "preprocessing": "string",
    "ethicalConsiderations": "string",
    "maintenancePlan": "string"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/data-cards", map[string]any{"projectId": "00000000-0000-0000-0000-000000000000", "datasetId": "00000000-0000-0000-0000-000000000000", "name": "string", "version": "string", "motivation": "string", "composition": map[string]any{}, "collectionMethod": "string", "preprocessing": "string", "ethicalConsiderations": "string", "maintenancePlan": "string"})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400403

Other Compliance endpoints