Skip to content
POST/api/v1/marketplace/installed

Install a marketplace template

Installs a marketplace template into org_installed_templates. Body: orgId (uuid) and template {id, name, version (default '1.0.0'), config (default {}), source: marketplace|org|shared (default marketplace)}. Keyed on the (org_id, template_id, template_version) unique constraint, so it never creates a duplicate row — but it is an upsert, not a no-op: re-installing the same version overwrites config, re-stamps installed_at/installed_by, and clears uninstalled_at (un-uninstalling a soft-deleted row). If the template declares a config contract (templates.config_schema for a DB template, or the catalog configSchema for a built-in), the supplied config must satisfy it or the request is 400 CONFIG_SCHEMA_VIOLATION; a previously-pinned config for an older version is never re-validated. Returns 201. requiredPermission integrations:create; audit-logged.

Authentication

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

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "template": {
    "id": "string",
    "name": "string",
    "version": "1.0.0",
    "config": {},
    "source": "marketplace"
  }
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "template": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "version": {
              "default": "1.0.0",
              "type": "string",
              "minLength": 1,
              "maxLength": 32
            },
            "config": {
              "default": {},
              "type": "object",
              "additionalProperties": {}
            },
            "source": {
              "default": "marketplace",
              "type": "string",
              "enum": [
                "marketplace",
                "org",
                "shared"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "version",
            "config",
            "source"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "orgId",
        "template"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Installed.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/marketplace/installed \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "template": { "id": "string", "name": "string", "version": "1.0.0", "config": {}, "source": "marketplace" } }'

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/marketplace/installed", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "orgId": "00000000-0000-0000-0000-000000000000",
    "template": {
      "id": "string",
      "name": "string",
      "version": "1.0.0",
      "config": {},
      "source": "marketplace"
    }
  }),
});
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/marketplace/installed",
    headers=headers,
    json={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "template": {
        "id": "string",
        "name": "string",
        "version": "1.0.0",
        "config": {},
        "source": "marketplace"
    }
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","template":{"id":"string","name":"string","version":"1.0.0","config":{},"source":"marketplace"}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/marketplace/installed", 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

400401403409429500

Other Marketplace endpoints