Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Get project safety alert

client.safety.alerts.retrieve(stringid, RequestOptionsoptions?): SafetyAlert { id, created_at, error_type, 7 more }
GET/safety/alerts/{id}

Get a safety alert belonging to the authenticated API project.

ParametersExpand Collapse
id: string

Project safety alert ID

maxLength38
ReturnsExpand Collapse
SafetyAlert { id, created_at, error_type, 7 more }
id: string
created_at: number
formatunixtime
error_type: "potentially_unintended_data_transfer" | "potentially_unintended_data_access" | "potentially_unintended_destructive_activity" | "other"
model: string
object: "safety.alert"
reason: string | null

A customer-safe description derived from error_type, or null for zero data retention requests.

request_id: string
request_paused: boolean

Whether block registration succeeded for this request. This does not confirm that response execution stopped.

response_id: string
detailed_explanation?: string | null

A generated explanation, temporarily available for eligible zero data retention alerts. Omitted when unavailable.

Get project safety alert

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const safetyAlert = await client.safety.alerts.retrieve('id');

console.log(safetyAlert.id);
{
  "id": "alert_0123456789abcdef0123456789abcdef",
  "object": "safety.alert",
  "created_at": 1787659200,
  "request_id": "req_123",
  "response_id": "resp_123",
  "model": "gpt-6-astra",
  "request_paused": true,
  "error_type": "potentially_unintended_data_access",
  "reason": "Potentially unintended data access."
}
Returns Examples
{
  "id": "alert_0123456789abcdef0123456789abcdef",
  "object": "safety.alert",
  "created_at": 1787659200,
  "request_id": "req_123",
  "response_id": "resp_123",
  "model": "gpt-6-astra",
  "request_paused": true,
  "error_type": "potentially_unintended_data_access",
  "reason": "Potentially unintended data access."
}