API · /clean-songs
Clean Songs-documentatie
Clean Songs Text Analysis is a deterministic API that checks customer-provided text in Portuguese and English for profanity, drug references, violence, and explicit sexual content. Choose the categories to check, add custom terms, and flag phrases for human review. Each response returns an approved, rejected, or review_required status, with matched rules, minimal text evidence, line numbers, and a versioned rule set. The API does not search for, retrieve, or provide song lyrics. Submitted text is processed without storage by the analysis backend. Customers are responsible for having the necessary rights to submit their content. Designed to support moderation and editorial review. Results are based on lexical rules and do not replace human judgment.
Eindpunten
-
GET
/v1/health— HealthCheck service availability.
-
GET
/v1/lyric-submissions/{submission_id}— Check lyric submission statusReturns only the submission ID and curation status (pending, approved or rejected). Approved lyrics go to an internal archive and are still not displayed to app users. Requires the X-Submission-Token header with the one-time token returned at creation.
-
GET
/v1/reports/{report_id}— ReportsReturns only the report ID and administrative review status (pending, approved or rejected). Approved means the report was accepted; it does not publish a rule change. Requires the X-Report-Token header with the one-time tracking token returned when the report was created.
-
POST
/v1/analyze-text— Analyze TextAnalyze customer-provided text in Portuguese or English.
beperken: 1/s -
POST
/v1/lyric-submissions— Submit lyrics for curationSubmit complete lyrics with song title and artist for human curation. Requires rights_confirmed and consent_to_store set to true. Submitted lyrics are never displayed to app users. Returns a submission ID and a one-time tracking token.
beperken: 1/s -
POST
/v1/reports— Report an analysis issueSubmit a false-positive or false-negative report for human review. Includes optional evidence of up to 280 characters and requires explicit consent to store the report. Reports do not automatically change detection rules.
Authenticatie
Stuur je API-key mee in de header x-oanor-key.
curl https://api.oanor.com/clean-songs/your/path \
-H "x-oanor-key: oanor_live_..."