​
Welcome

It’s easy to get started with the Reality Defender API. With a couple simple lines of code, you can upload files to Reality Defender!

​
Authentication

The Reality Defender API uses a secure and straightforward authentication mechanism via the X-API-KEY header. Every API request must include your unique API key in this header to authenticate and authorize your access to the platform’s features and resources.

You will need access to the Reality Defender web platform to generate an API key. Navigate to our API key settings to create a key.

API keys are linked to a user. Organization administrators can view uploads from all users, but only uploads for a given user show up by default in the Dashboard.

​
Request a signed URL

You must request a signed URL to which you will upload your file.

curl --location 'https://api.prd.realitydefender.xyz/api/files/aws-presigned' \
--header 'X-API-KEY: your-api-key-here' \
--header 'Content-Type: application/json' \
--data '{
    "fileName": "your-file-path-here"
}'

​
Upload a file to the signed URL

Next, upload a file to the signed URL that you received in the prior step.

When uploading the file, you should only pass in the file itself. You do not need to include any other headers or metadata.

curl --location --request PUT "your-signed-url-here" \
--data-binary "your-file-path-here"

​
Request a result

Finally, now that you’ve uploaded a file, you can request a result. You will need the request_id that is returned from the prior step.

Larger files may take longer to analyze. You need to poll the API until the results returns, or set up a webhook.

curl --location 'https://api.prd.realitydefender.xyz/api/media/users/{request_id}' \
--header 'X-API-KEY: your-api-key-here' \
--header 'Content-Type: application/json'

​
Interpreting the results

The Reality Defender API returns a lot of detailed information about our deepfake detection results. However, it’s recommended to focus specifically on the ensemble results. View our Media Detail documentation for more detail.