Media Detail

Media Detail

curl --request GET \
  --url https://api.prd.realitydefender.xyz/api/media/users/{requestId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.prd.realitydefender.xyz/api/media/users/{requestId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.prd.realitydefender.xyz/api/media/users/{requestId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prd.realitydefender.xyz/api/media/users/{requestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prd.realitydefender.xyz/api/media/users/{requestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prd.realitydefender.xyz/api/media/users/{requestId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prd.realitydefender.xyz/api/media/users/{requestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

GET

api

media

users

{requestId}

Media Detail

curl --request GET \
  --url https://api.prd.realitydefender.xyz/api/media/users/{requestId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.prd.realitydefender.xyz/api/media/users/{requestId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.prd.realitydefender.xyz/api/media/users/{requestId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prd.realitydefender.xyz/api/media/users/{requestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prd.realitydefender.xyz/api/media/users/{requestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prd.realitydefender.xyz/api/media/users/{requestId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prd.realitydefender.xyz/api/media/users/{requestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

requestId

string

Returns deepfake detection result for specified requestId.

This endpoint returns the results for a specific upload. When you upload a file or submit a social media URL, the response of a successful request will contain the requestId. You can also find your requestId in the URL path when you access the upload in the web application.

Authorization

To fetch media detail, you must include the x-api-key in your request headers. This key is essential for authenticating your request and ensuring secure access to the API.

Sample Code Snippet

Here’s an example of how you can fetch the results for an uploaded file or social media URL.

REQUEST_ID="your-requestId"
API_KEY="your-api-key"

curl -X GET \
  "https://api.prd.realitydefender.xyz/api/media/users/${REQUEST_ID}" \
  -H "X-API-KEY: ${API_KEY}" \
  -H "Content-Type: application/json"

import requests 

requestId = "your-request-id"
url = f"https://api.prd.realitydefender.xyz/api/media/users/{requestId}"
headers = {
    "X-API-KEY": "your-api-key",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers).json()
print(response.get('filename','N/A'))
print(response.get('overallStatus','N/A'))

Sample Response

{
    "filename": "rd-file-name",
    "originalFileName": "original-file-name", 
    "requestId": "request-id",
    "uploadedDate": "uploaded-date",
    "mediaType": "media-type", // AUDIO, VIDEO, TEXT, IMAGE
    "socialLink": "social-link", // populated for social media submissions
    "socialLinkDownloaded": true, // populated for social media submissions
    "socialLinkDownloadFailed": false, // populated for social media submissions
    "showAudioResult": "show-audio-result", // True, False
    "audioRequestId": "audio-request-id", // populated if showAudioResult is True
    "userId": "user-id",
    "institutionId": "institution-id", 
    "releaseVersion": "2.3.1",
    "resultsSummary": {
        "status": "status", // AUTHENTIC, FAKE, SUSPICIOUS, NOT_APPLICABLE, UNABLE_TO_EVALUATE
        "metadata": {
            "languages": ["language"], // detected languages include english, spanish, and portuguese
            "finalScore": score // ensemble score goes from 0-100
        }
    },
    "models": [
        // individual model results
    ]
}

Response Details

NOT_APPLICABLE

Reality Defender will return NOT_APPLICABLE as a status if the file contains certain characteristics that are known to impact accuracy. The reason behind the NOT_APPLICABLE response will be returned as a list in the metadata feel. For example, see below for a resultsSummary returned for an image that was not applicable.

"resultsSummary": {
    "status": "NOT_APPLICABLE",
    "metadata": {
      "reasons": [
        {
          "code": "relevance",
          "message": "no faces detected/faces too small"
        }
      ]
    }
}

Image Reasons
Possible reasons returned for NOT_APPLICABLE are:

code: relevance
- message: no faces detected/faces too small

Video Reasons
Currently, our video files do not output reasons. Audio Reasons
Possible reasons returned for NOT_APPLICABLE are:

code: duration
- message: audio too short (<1.5s)
code: detected
- message: dialtone and/or music
code: cross-talk
- message: more than one speaker detected
code: quality
- audio too noisy
code: language
- audio is more likely in language

UNABLE_TO_EVALUATE Response

Reality Defender will return UNABLE_TO_EVALUATE if an error occurred while processing the file. This is typically caused by timeouts. You can try again, or upload a smaller file. Here is an example of the resultsSummary returned for an image that is unable to be evaluated.

"resultsSummary": {
    "status": "UNABLE_TO_EVALUATE",
    "metadata": {},
    "error": {
      "code": "model-error",
      "message": "An error occurred while processing the file. Please try uploading the file again."
    }
}

All Media Create User Feedback

⌘I

API Documentation

Endpoint Examples

Authorization

Sample Code Snippet

Sample Response

Response Details

NOT_APPLICABLE

UNABLE_TO_EVALUATE Response

​Authorization

​Sample Code Snippet

​Sample Response

​Response Details

​NOT_APPLICABLE

​UNABLE_TO_EVALUATE Response

Authorization

Sample Code Snippet

Sample Response

Response Details

NOT_APPLICABLE

UNABLE_TO_EVALUATE Response