POST/api/v1/catalog/deprecate

Deprecate a catalog entry

Marks a catalog entry (provider/scorer) as deprecated. New evals can't select deprecated entries; existing references continue to work until the entry is removed.

Authentication

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

Request body required

Example

{
  "entry_id": "string",
  "deprecation_message": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "entry_id"
      ],
      "properties": {
        "entry_id": {
          "type": "string"
        },
        "deprecation_message": {
          "type": "string"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Deprecated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/catalog/deprecate \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "entry_id": "string", "deprecation_message": "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/catalog/deprecate",
  body: {
    "entry_id": "string",
    "deprecation_message": "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/catalog/deprecate",
    body={
    "entry_id": "string",
    "deprecation_message": "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/catalog/deprecate", map[string]any{"entry_id": "string", "deprecation_message": "string"})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401403429

Other Integrations endpoints