API Reference

Libraries

TypeScript

0.11.0-alpha

npm install safetykit

Read Docs

Python

0.10.0a0

pip install safetykit

Read Docs

Java

0.3.0

implementation("com.safetykit:safetykit-java:0.3.0")

Read Docs

Kotlin

0.3.0

implementation("com.safetykit:safetykit-kotlin:0.3.0")

Read Docs

Ruby

0.62.0

gem "safetykit"

Read Docs

API Overview

Data

Ingest data for fraud detection and risk analysis.

Add data

POST/v1/data/{namespace}

Create upload URL

POST/v1/data/{namespace}/requests/upload-url

Get request status and inline results

GET/v1/data/{namespace}/requests/{requestId}

Get download URL

GET/v1/data/{namespace}/requests/{requestId}/results/download-url

Update namespace settings

PUT/v1/data/{namespace}/settings

Streams

Ingest and monitor livestream content.

Add stream

POST/v1/streams/{namespace}

Add frame

POST/v1/streams/{namespace}/frames

Add transcript

POST/v1/streams/{namespace}/transcripts

Agent Decisions

Send human reviewer final verdicts to SafetyKit. This feedback improves the accuracy of SafetyKit’s automated decisions over time.

Record an agent decision

POST/v1/agent_decisions

Access Tokens

Exchange a long-lived API key for a short-lived access token suitable for delegated or time-boxed use.

Create short-lived access token

POST/v1/access_tokens

Async

Beta. Send backend events for account, content, user interaction, report, appeal, and moderation activity.

Queue event for async ingest (Beta)

POST/v1/async/events

Content

Classify user-authored text and images synchronously and receive a decision in the response.

Classify content

POST/v1/content

Deletion Requests

Submit end-user deletion requests. Accepted requests are processed asynchronously.

Create deletion request

POST/v1/deletion_requests

Client Sessions

Beta. Create browser-safe Webapp SDK session tokens from authenticated server-side code.

Create webapp SDK session

POST/v1/sessions

Beta

BetaEvents

Beta. Send backend events for account, content, user interaction, report, appeal, and moderation activity.

Create event (Beta)

POST/v1/events