Skip to main content
DELETE
/
v1
/
custom-metric
/
{metric_id}
Delete Custom Metric
curl --request DELETE \
  --url https://api.getbluejay.ai/v1/custom-metric/{metric_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "name": "<string>",
  "description": "<string>",
  "response_type": "pass_fail",
  "agent_id": 123,
  "min_value": 123,
  "max_value": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "<string>",
  "tags": [
    "<string>"
  ],
  "scoring_guidance": "<string>",
  "eval_route": "AUTO",
  "model": "<string>",
  "audio_model": "<string>",
  "temperature": 123,
  "enum_options": [
    "<string>"
  ],
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "allow_not_applicable": false
}
Integration Prompt for AI Agents
# Bluejay — Testing & Monitoring Platform for Conversational AI Agents

You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.

## Delete Custom Metric — DELETE /v1/custom-metric/{metric_id}

> **What this endpoint does:** Delete a specific custom metric by ID.

**Endpoint:** DELETE `https://api.getbluejay.ai/v1/custom-metric/{metric_id}`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| metric_id | string |  |
| X-API-Key | string | API key required to authenticate requests. |

### Example
**DELETE request:**
```python
import requests

def delete_custom_metric(metric_id: str, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/custom-metric/{metric_id}"
    headers = {"X-API-Key": api_key}
    response = requests.delete(url, headers=headers)
    response.raise_for_status()
    return response.json()
```

### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error.

### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?

Then implement the integration, export it, and confirm it compiles/passes lint.
This endpoint allows you to delete a custom metric from your agent. Provide the metric ID in the path to permanently remove the custom metric.

Headers

X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

metric_id
string<uuid>
required

Response

Successful Response

Represents a custom metric entry in the database.

name
string
required
description
string
required
response_type
enum<string>
required

Enum representing the possible response types for custom metrics.

Available options:
pass_fail,
yes_no,
qualitative,
quantitative,
json,
enum
agent_id
integer | null
min_value
number | null
max_value
number | null
created_at
string<date-time> | null
id
string<uuid> | null

Unique identifier for the custom metric

category
string | null
tags
string[]
scoring_guidance
string | null
eval_route
enum<string> | null
default:AUTO

Enum representing the evaluation route of a call.

Available options:
AUDIO,
TEXT,
AUTO
model
string | null
audio_model
string | null
temperature
number | null
enum_options
string[] | null
organization_id
string<uuid> | null
allow_not_applicable
boolean
default:false