POST /image/classification

Initiates a new image analysis. Specify the URL of the image to be analyzed.

Example Request

curl -H 'x-api-key: <YOUR_API_KEY>' -H 'Content-Type: application/json' -X POST -d '{"url":"<IMAGE_URL>"}' https://verity-api.gumgum.com/image/classification

Example Response

{ "uuid": "06cbe788-feda-4929-9782-15549d722a76", "url": "https://nationalinterest.org/sites/default/files/main_images/sdgvsdgdfd.jpg", "acceptedAt": "2021-06-10T00:05:22.508Z" }

Header

Field

Type

Description

Optional/Required

Field

Type

Description

Optional/Required

x-api-key

String

GumGum authentication token.

Required

Content-Type

String (value : application/json)

Describing the MIME type for the application as being JSON.

Required

Body

Parameter name

Type

Description

Optional/Required

Parameter name

Type

Description

Optional/Required

sourceUrl

String

URL of the page where the image is located. Not currently supported.

Optional

url

String

URL of image to be analyzed. See supported image formats.

Required

callbackUrl

String

URL to target server listening for Verity data.

Optional


The contents of these documents and any attachments contain GumGum, Inc. confidential information and are legally protected from disclosure.