Skip to main content
Classify an image from URL

Authorizations

X-Api-Key
string
header
required

Your API key.

Headers

Accept
enum<string>

Response content type. Supported: application/json, text/plain.

Available options:
application/json,
text/plain

Body

multipart/form-data
file_url
string
required

The URL of the image to be classified.

ref_id
string

An optional reference ID to associate with the classification request.

with_morphing
boolean

Set it to true if you also want to analyze people's faces in the image using morphing.

with_tampering
boolean

Set it to true if you also want to analyze signs of tampering or manipulation without the aid of a Generative AI

with_heatmap
boolean

Set it to true if you also want to get an AI content heatmap.

with_smart_analysis
boolean

Set it to true to enable the Smart Full Analysis: a proprietary scoring algorithm selects the most informative areas of the image, which are classified as separate crops by the most advanced model of the Revelio family and then combined into an overall verdict. Being an advanced, smart version of both, it replaces the standard full analysis and the heatmap analysis: it cannot be combined with with_heatmap, sending both set to true returns a 422 error. You must be enabled in your pricing plan to use it, otherwise the parameter is ignored. See Smart Full Analysis for details.

webhook_url
string

If specified, the classification result will also be automatically sent to the entered URL. Otherwise, the result can be obtained by polling the relative endpoint. Please note that in order to use a webhook callback URL you need to request a specific enablement, otherwise the parameter is ignored. Moreover, the system may cache the analysis results of repeated submissions, i.e. submissions of the same file with the same options: in this case the webhook won't be called and the results would be accessible only by polling the relative endpoint.

with_xai
boolean

Set it to true to enable the XAI – eXplainable AI scope: besides the verdict, the Revelio models return information on the areas of the image they focused on during the classification (attention map and attention graph). You must be enabled in your pricing plan to use it, otherwise the parameter is ignored. See XAI – eXplainable AI for details. Data Transfer Notice: Enabling this feature transfers your image data to our EU cloud infrastructure for model inference.

with_llm_xai
boolean

Set it to true, together with with_xai, to also get the AI-powered explanations: a natural-language description of the regions that received the most attention, returned in the description of the explanations of the per-model results once the deferred results are ready. It is ignored when with_xai is not enabled. If XAI is included in your pricing plan but the AI-powered explanations are not, a request with with_llm_xai=true is rejected with a 403 error. The credits of the explanations that cannot be generated are refunded. The AI-powered explanations are generated with models that are not developed by identifAI.

llm_xai_language
enum<string>

Language of the AI-powered explanations (case-insensitive). If omitted, the default language of your pricing plan is used. It is applied only together with with_llm_xai; an unsupported value is rejected with a 400 error.

Available options:
english,
italian,
spanish,
german
deferred_webhook_url
string

If specified, the URL is notified once when the deferred results of the submission are complete (e.g. the textual explanations of the XAI maps and of the heatmap), after the main results sent to webhook_url. The notification carries the event submission.deferred.completed: see Deferred results for the payload. The same enablement, domain restrictions and authentication of webhook_url apply. Delivery is at least once: deduplicate by identifier, and note that an expired notification can be followed by a second one with the real outcome, which supersedes it. If omitted or empty, no deferred notification is sent.

no_cache
boolean

Set it to true to force the system to reprocess the image even if it has been previously submitted with the same options. This may result in additional charges.

prevent_c2pa_forces
boolean

If true, C2PA signature does not force the origin to artificial. If false or undefined, C2PA signature will force the origin to artificial (current behaviour).

with_nsfw
boolean

Set it to true if you also want to enable NSFW (Not Safe For Work) content detection.

Response

The classification identifier. The format depends on the Accept header.

identifier
string
Example:

"8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0"