Delete a model response | Sample

1 parameter

response_idstringrequired

The identifier of the model response to delete.

3 status codes

200Returns confirmation that the specified model response was deleted.

404Returned when no model response exists with the given `response_id`.

codestringrequired

messagestringrequired

paramstringrequired

typestringrequired

misalignmentobjectoptional

429Returned when the request exceeds the rate limit.

errorobjectrequired

Error handling

A 404 is returned when response_id does not identify an existing response. A 429 is returned when the request exceeds the rate limit. Supply the exact response identifier and retry later if rate limiting occurs.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.responses.delete({ responseId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "code": "123456",
  "message": "This is an example message.",
  "param": "example_value",
  "type": "standard",
  "misalignment": {
    "error_type": "example_value",
    "detailed_explanation": "example_value",
    "steer": {
      "message": "This is an example message."
    }
  }
}

Request

Response

Errors