Skip to navigation

API: `safety_identifier` attributes a request to your own end user

POST /v1/audio/speech, POST /v1/audio/stream and POST /v1/audio/stream/with-timestamps accept an optional safety_identifier: a stable, opaque id for the end user of your application on whose behalf the request is made.

Send it when many of your own users share one workspace. Abuse can then be attributed to, limited for, or blocked for that one end user instead of your whole workspace.

  • Send a hash, never personal data. The field takes 1 to 64 characters of letters, digits and . _ - : | + / =, so an email address is rejected with 400 validation_failed. A keyed hash of your internal user id is the recommended value.
  • It is metadata, not content. It is recorded with the request even under zero data retention.
  • Per-end-user limits can be set for your workspace, nested inside its own limits. Over one, a request returns 429 naming the safety_identifier.
  • A blocked end user returns 403 safety_identifier_blocked. Your other end users are unaffected.

Omitting the field changes nothing. No API version change is needed. See Safety Identifiers.