Delete Scorecard

{
  "id": "sc-9f8b7c6d5e4a3b2c1d0e",
  "orgId": "org-1234567890abcdef",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "metrics": [
    {
      "structuredOutputId": "output-9876543210fedcba",
      "conditions": [
        {
          "comparator": ">=",
          "points": 50,
          "value": 90
        },
        {
          "comparator": "<",
          "points": 20,
          "value": 90
        }
      ]
    }
  ],
  "name": "Customer Support Quality Scorecard",
  "description": "Scorecard evaluating key metrics for customer support call quality and agent performance.",
  "assistantIds": [
    "assistant-1122334455"
  ]
}

Deletes the scorecard identified by its ID.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequired

Response

idstring

This is the unique identifier for the scorecard.

orgIdstring

This is the unique identifier for the org that this scorecard belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the scorecard was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the scorecard was last updated.

metricslist of objects

These are the metrics that will be used to evaluate the scorecard. Each metric will have a set of conditions and points that will be used to generate the score.

namestring<=80 characters

This is the name of the scorecard. It is only for user reference and will not be used for any evaluation.

descriptionstring<=500 characters

This is the description of the scorecard. It is only for user reference and will not be used for any evaluation.

assistantIdslist of strings

These are the assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants' calls.

$	curl -X DELETE https://api.vapi.ai/observability/scorecard/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'