Imagga
API integration

list_all_imagga_usage

Get Imagga subscription usage statistics for the current billing period. Returns: billing_period_start, billing_period_end, monthly_limit, monthly_requests, monthly_processed, weekly_requests, weekly_processed, daily_requests, daily_processed, daily_for, total_requests, total_processed, last_usage, daily, weekly, monthly, concurrency.

create_a_imagga_upload

Upload an image (or supported video) file to imagga and receive an upload_id that can be passed as image_upload_id to analysis endpoints such as tagging, categorization, and cropping. Returns: upload_id, score. Requires image (multipart file) or image_base64.

get_single_imagga_upload_by_id

Check the status of an uploaded file in imagga and retrieve its content id. Returns: upload_id. Required: id. Uploaded files expire automatically after the retention window.

get_single_imagga_ticket_by_id

Get the status and result of an Imagga asynchronous job (face grouping, index training, batch processing) by its ticket id. Returns: id, is_final, result.g. face grouping clusters). Required: id. Supports all=1 to retrieve intermediate results; tickets are retained for 24 hours after the job finishes and are deleted once the final result is retrieved.

create_a_imagga_tag

Analyze an uploaded image with Imagga's Image Tagging API (v2) and return a flat list of descriptive tags. Returns: tags.en). Provide exactly one image input: image (multipart file) or image_base64.

get_single_imagga_tag_by_id

Get Imagga's Image Tagging API (v2) tags for previously uploaded images by passing the image upload id (comma-separate ids to batch) in the path. Returns: tags.en). Required: id.

list_all_imagga_tags

Analyze an image by URL or upload id with Imagga's Image Tagging API (v2) and return a flat list of descriptive tags with confidence scores. Returns: tags.en). Provide exactly one image input: image_url or image_upload_id.

create_a_imagga_structured_tag

Analyze an image with Imagga's Structured Image Tagging API (v3) via binary upload or base64 content. Returns: caption, metadata, tags. Requires exactly one of image or image_base64.

get_single_imagga_structured_tag_by_id

Get structured semantic tags for a previously uploaded image by id with Imagga's Structured Image Tagging API (v3). Returns: caption, metadata, tags. Required: id.

list_all_imagga_structured_tags

Analyze an image by URL or upload id with Imagga's Structured Image Tagging API (v3). Returns: caption, metadata, tags. Requires exactly one of image_url or image_upload_id.

create_a_imagga_category

Categorize an image with an Imagga categorizer by submitting a multipart image upload or a base64-encoded image. Returns: categories.en labels. Required: categorizer_id, plus the image itself via image or image_base64.

get_single_imagga_category_by_id

Get categorization results for a specific image under an Imagga categorizer by id (comma-separated upload ids are supported). Returns: categories.en labels. Required: id and categorizer_id.

list_all_imagga_categories

List the categories defined for an Imagga categorizer (e.g. personal_photos, nude, general_v3). Returns: categories.en labels. Required: categorizer_id.

create_a_imagga_adult_content_moderation

Classify an image for adult or explicit content in Imagga by uploading a binary image or base64 content. Returns: categories, tags. Requires an image input: image or image_base64.

get_single_imagga_adult_content_moderation_by_id

Get adult content moderation results for a previously uploaded image by id (upload id from POST /v2/uploads; comma-separated ids allowed). Returns: categories, tags. Required: id.

list_all_imagga_adult_content_moderation

Classify an image for adult or explicit content in Imagga by image URL or uploaded image id. Returns: categories, tags. Provide one of image_url or image_upload_id.

create_a_imagga_text_moderation

Moderate text in an image uploaded directly to Imagga: OCR extracts visible text and classifies it into sensitive and PII-related categories. Returns: categories. Requires either image (binary file) or image_base64.

get_single_imagga_text_moderation_by_id

Get OCR text moderation results from Imagga for a previously uploaded image, accepting comma-separated upload ids. Returns: categories. Required: id.

list_all_imagga_text_moderation

Moderate text visible in an image with Imagga's Text Moderation API: OCR extracts the text from the image at image_url and classifies it into sensitive and PII-related categories. Returns: categories. Required: image_url.

create_a_imagga_faces_detection

Detect human faces in an image via imagga using a binary upload or base64 payload. Returns a faces array where each detected face includes confidence, bounding-box coordinates, attributes, landmarks, and a face_id when requested. Requires an image input: image (multipart binary upload) or image_base64.

get_single_imagga_faces_detection_by_id

Get face detections in imagga for previously uploaded images by id. Returns a faces array where each detected face includes confidence, bounding-box coordinates, attributes, landmarks, and a face_id when requested. Required: id (one or more comma-separated upload ids).

list_all_imagga_faces_detections

Detect human faces in an image in imagga by image URL or upload id. Returns a faces array where each detected face includes confidence, bounding-box coordinates, attributes, landmarks, and a face_id when requested. Requires one image input: image_url or image_upload_id.

create_a_imagga_faces_similarity

Create a face similarity comparison in Imagga by sending images for face comparison. Returns: score. Provide the image input as a multipart upload (image) or base64-encoded content (image_base64).

get_single_imagga_faces_similarity_by_id

Get a face similarity result by id in Imagga using the /id variant of the Face Similarity API, where id holds the comma-separated upload ids to compare. Returns: score. Required: id.

list_all_imagga_faces_similarities

Compare faces in two images with the Imagga Face Similarity API. Returns: score.

create_a_imagga_faces_categorizer

Categorize the faces in an image with an Imagga face categorizer (e.g. gender, ethnicity_v2), submitting the image as a multipart upload (image) or base64-encoded content (image_base64). Returns the endpoint-specific face categorization result object. Required: face_categorizer_id.

get_single_imagga_faces_categorizer_by_id

Get the face categorization result for a specific image from an Imagga face categorizer (e.g. gender, ethnicity_v2), identified by its image id. Returns the endpoint-specific face categorization result object. Required: id and face_categorizer_id.

list_all_imagga_faces_categorizers

List the possible face categories for an Imagga face categorizer (e.g. gender or ethnicity_v2). Returns the supported categories under categories. Required: face_categorizer_id.

create_a_imagga_faces_assignment

Create a face assignment in Imagga, associating a face_id (generated by the faces/detections endpoint) with an entry_id. Returns the created assignment result payload with endpoint-specific fields not enumerated in the Imagga docs. Required: face_id, entry_id.

delete_a_imagga_faces_assignment_by_id

Delete an Imagga face assignment by its id (the face_id of the assignment). Returns an empty 204 response on success. Required: id.

list_all_imagga_faces_assignments

List Imagga face assignments for a given face_id, or pass all=1 to retrieve all assignments. Returns assignment records with face_id, entry_id, and entry_title.

create_a_imagga_faces_grouping

Create an asynchronous face grouping job in Imagga: submits a set of faces (identified by their face_id) to be grouped into visually similar clusters. Returns: ticket_id, score.

create_a_imagga_text

Create an OCR text extraction in Imagga by submitting an image directly — a multipart image file or base64-encoded content. Returns the detected text items, each with its recognized data and bounding-box coordinates (xmin, ymin, xmax, ymax, width, height). Provide image or image_base64 (one is required). Experimental endpoint.

get_single_imagga_text_by_id

Get Imagga OCR text recognition results for previously uploaded images by id — the upload_id returned by POST /v2/uploads; comma-separated ids are supported. Returns the text array of detected items, each with data and bounding-box coordinates (xmin, ymin, xmax, ymax, width, height). Required: id. Experimental endpoint.

list_all_imagga_text

List Imagga OCR text recognition results for an image, detecting readable text and the location of each text region. Returns the text array of detected items, each with data and bounding-box coordinates (xmin, ymin, xmax, ymax, width, height). Required: image_url. Experimental endpoint.

create_a_imagga_similar_images_category

Index images into a category-based similarity index in Imagga (Similar Images Search API). Returns a ticket_id for the asynchronous indexing job — query the /tickets endpoint for the final result. Required: categorizer_id, index_id. Supply images via image_url or image_upload_id; general_v3 is the recommended categorizer.

list_all_imagga_similar_images_categories

Search a trained category-based similarity index in Imagga with an unlabeled image to find visually and semantically similar images. Returns: count, images. Required: categorizer_id, index_id. Supply the query image via image_url or image_upload_id.

imagga_similar_images_categories_bulk_delete

Delete an entire category-based similarity index or a single entry from it in Imagga. Returns an empty 204 response on success. Required: categorizer_id, index_id. Omit entry_id to delete the entire index.

create_a_imagga_color

Extract the dominant colors of an image in Imagga from a binary multipart upload or base64-encoded image content. Returns the colors object including image_colors, background_colors, foreground_colors, color_variance, color_percent_threshold, and object_percentage. Requires image or image_base64.

get_single_imagga_color_by_id

Extract the dominant colors of a previously uploaded image in Imagga by passing its upload id. Returns the colors object including image_colors, background_colors, foreground_colors, color_variance, color_percent_threshold, and object_percentage. Required: id (comma-separated upload ids are accepted).

list_all_imagga_colors

Extract the dominant colors of an image with the Imagga Color Extraction API, given an image URL or a previously uploaded image id. Returns the colors object including image_colors, background_colors, foreground_colors, color_variance, color_percent_threshold, and object_percentage. Requires image_url (or image_upload_id as an alternative).

create_a_imagga_cropping

Create smart cropping coordinates for an imagga image supplied as a multipart file upload or base64 content. Returns the croppings array of crop rectangles with x1, x2, y1, y2 coordinates and target_width/target_height. Requires image (multipart file) or image_base64.

get_single_imagga_cropping_by_id

Get smart cropping coordinates for a previously uploaded imagga image by id (the upload id from POST /v2/uploads). Returns the croppings array of crop rectangles with x1, x2, y1, y2 coordinates and target_width/target_height. Required: id. Comma-separated upload ids are supported.

list_all_imagga_croppings

List smart cropping coordinates for an imagga image, returning the most visually important crop region per requested resolution. Returns the croppings array of crop rectangles with x1, x2, y1, y2 coordinates and target_width/target_height. Requires image_url or image_upload_id.

create_a_imagga_smart_cropping

Create structured crop boxes for an uploaded image in imagga by sending a binary image file or base64-encoded content. Returns: croppings, subject, reason, metadata. Requires either image or image_base64 (multipart/form-data).

get_single_imagga_smart_cropping_by_id

Get structured smart-cropping results for an image in imagga by id. Returns: croppings, subject, reason, metadata. Required: id.

list_all_imagga_smart_croppings

List structured crop boxes for an image in imagga by analyzing a public image URL or an uploaded image id. Returns: croppings, subject, reason, metadata. Requires either image_url or image_upload_id.

create_a_imagga_remove_background

Remove the background of an image in Imagga and get the subject cut-out. Provide either image (multipart file upload) or image_base64 (base64-encoded content). Returns a binary PNG image (not JSON), transparent by default.

get_single_imagga_remove_background_by_id

Get the background-removed subject cut-out for previously uploaded Imagga images by id; comma-separated upload ids (from POST /v2/uploads) are accepted. Returns a binary PNG image (not JSON). Required: id.

list_all_imagga_remove_background

Remove the background of an image in Imagga and get the subject cut-out. Supply image_url (direct image URL) or image_upload_id (upload ID from the Imagga uploads endpoint). Returns a binary PNG image (not JSON), transparent by default.