Skip to content
POST/api/v1/shadow-ai/ingest

Bulk-ingest shadow-AI sighting rows

Classifies egress-log rows against the AI-tool catalog and upserts shadow_ai_sightings. source + rows required; orgId/projectId resolvable from body, query, or api-key context (400 if unresolved). source may alternatively be supplied via the x-evalguard-source header.

Authentication

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

Parameters

x-evalguard-source in header

Alternative to body.source.

string

Request body required

Example

{
  "source": "zscaler",
  "rows": [
    {}
  ],
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "source",
        "rows"
      ],
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "zscaler",
            "netskope",
            "cloudflare",
            "okta",
            "generic"
          ]
        },
        "rows": {
          "type": "array",
          "minItems": 1,
          "maxItems": 10000,
          "items": {
            "type": "object",
            "additionalProperties": true
          },
          "description": "Egress-log rows (max 10,000 per call)."
        },
        "orgId": {
          "type": "string",
          "format": "uuid",
          "description": "Optional — resolvable from query/body/api-key context."
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "description": "Optional — resolvable from query/body/api-key context."
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

200OK.
201Ingested — {ingested, newSightings, updatedSightings, parsedRows, skipped, byReason}.
400(no description)
401(no description)
403Forbidden — PROJECT_ORG_MISMATCH.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/shadow-ai/ingest \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "source": "zscaler", "rows": [ {} ], "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000" }'

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/shadow-ai/ingest", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "source": "zscaler",
    "rows": [
      {}
    ],
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000"
  }),
});
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/shadow-ai/ingest",
    headers=headers,
    json={
    "source": "zscaler",
    "rows": [
        {}
    ],
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"source":"zscaler","rows":[{}],"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/shadow-ai/ingest", 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 Security endpoints