Skip to content
POST/api/v1/scorers/local-model

Create or update a local-model scorer config

Upserts a local-model-backed scorer for an org. Provide id to update an existing config; omit it to create. requiredRole: member.

Authentication

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

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "endpointUrl": "https://example.com",
  "modelName": "string",
  "format": "openai",
  "promptTemplate": "string",
  "parseResponse": "json-score",
  "passThreshold": 0.7,
  "timeoutMs": 30000,
  "maxRetries": 2,
  "headers": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "orgId",
        "name",
        "endpointUrl",
        "modelName",
        "format",
        "promptTemplate",
        "parseResponse"
      ],
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid"
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Present = update existing config; absent = create."
        },
        "name": {
          "type": "string",
          "maxLength": 100
        },
        "endpointUrl": {
          "type": "string",
          "format": "uri"
        },
        "modelName": {
          "type": "string"
        },
        "format": {
          "type": "string",
          "enum": [
            "openai",
            "ollama",
            "vllm",
            "tgi"
          ]
        },
        "promptTemplate": {
          "type": "string"
        },
        "parseResponse": {
          "type": "string",
          "enum": [
            "json-score",
            "text-binary",
            "logprobs"
          ]
        },
        "passThreshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "default": 0.7
        },
        "timeoutMs": {
          "type": "integer",
          "minimum": 1000,
          "maximum": 300000,
          "default": 30000
        },
        "maxRetries": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10,
          "default": 2
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated existing config.
201Created new config.
400(no description)
401(no description)
403Forbidden — member role required.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/scorers/local-model \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "endpointUrl": "https://example.com", "modelName": "string", "format": "openai", "promptTemplate": "string", "parseResponse": "json-score", "passThreshold": 0.7, "timeoutMs": 30000, "maxRetries": 2, "headers": {} }'

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/scorers/local-model",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "endpointUrl": "https://example.com",
    "modelName": "string",
    "format": "openai",
    "promptTemplate": "string",
    "parseResponse": "json-score",
    "passThreshold": 0.7,
    "timeoutMs": 30000,
    "maxRetries": 2,
    "headers": {}
  },
});
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/scorers/local-model",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "endpointUrl": "https://example.com",
    "modelName": "string",
    "format": "openai",
    "promptTemplate": "string",
    "parseResponse": "json-score",
    "passThreshold": 0.7,
    "timeoutMs": 30000,
    "maxRetries": 2,
    "headers": {}
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","name":"string","endpointUrl":"https://example.com","modelName":"string","format":"openai","promptTemplate":"string","parseResponse":"json-score","passThreshold":0.7,"timeoutMs":30000,"maxRetries":2,"headers":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/scorers/local-model", 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

400401403429

Other Evals endpoints