IRirisnet
AI check operations

Check a video with the AI.

An empty response is returned immediately. The actual body (CheckResult schema) is send to the callbackUrl after the AI has finished processing.

<b>NOTICE: Depending on your configuration and parameters this operation can be quite expensive on your credit balance.<b>

post/v2/check-video/{configId}

Request

  • Base URL
    https://api.irisnet.de
  • URL
    https://api.irisnet.de/v2/check-video/{configId}
  • Auth
    API key in header LICENSE-KEY

Path parameters

configIdstring uuid required

The configuration id from the Basic Configuration operations.

Query parameters

urlstring required

The url to the video that needs to be checked.

detailinteger

Set the detail level of the response.

  • 1 - The response only contains the Summary and possibly the Encoded schemas for basic information's (better API performance).
  • 2 - Additionally lists all broken rules (BrokenRule schema) according to the configuration parameters that were requested.
  • 3 - Also shows events (Event schema) that contains extended features to each found object.
imageEncodeboolean

Specifies whether or not to draw an output video that can be downloaded afterwards. The output video format will be MP4 containing H.264 encoding independent of the input format. The Encoded schema will be available in the response.

checkRateinteger

The milliseconds between each AI check. E.g. The AI will check 1 frame per second when checkRate is set to '1000'.

Request body

callbackUrlstring uri required

Define a URL where a response should be sent.

headersobject

Define headers to send to the URL.

Example request

{
  "callbackUrl": "http://www.example.com/callback?video",
  "headers": {
    "Authorization": "Basic Rm9yemEgTmFwb2xpLCBzZW1wcmUh"
  }
}

Response

operation accepted: wait for callback.

Changes

No recorded changes to this operation across all 1 revision of this API.