Authenticity Verification: get result

GET 
/api/technology/experimental/authenticity-verification/:task_id

Retrieve the result of an Authenticity Verification task.

Experimental feature - Authenticity Verification is experimental feature. It is under developmental and may change in the future.

Request

Path Parameters

task_id uuidrequired

ID of the task to get result of

Header Parameters

x-correlation-id X-Correlation-Id

Correlation ID is a special type of request ID which is unique over a series of requests and responses, identifying a transaction in a distributed system. Correlation ID will be generated if not provided.

x-request-id X-Request-Id

In distributed system architecture (microservices architecture) it is a unique ID of request and response combination throughout all components of a distributed system. Request ID will be generated if not provided.

Responses

200

Result response of Authenticity Verification task.

The response body contains task info in the task field. Depending on the task processing outcome, either result or error field is populated.

application/json

Schema

Schema

task

object

required

task_id uuidrequired

state TaskInfoState (string)required

Possible values: [pending, running, rejected, failed, done]

result

object

Result of Authenticity Verification task.

deepfake_detection

object

required

Result of Deepfake Detection operation.

channels

object[]

required

Array [

channel_number Channel Number (integer)required

Channel number (0-base indexed).

score

object

required

Score of the Deepfake Detection operation.

anyOf

MOD1

number

]

error

object

Result schema for a failed or rejected task.

type TaskErrorType (string)required

Possible values: [internal, task.validation-error]

Machine-readable error type.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "task": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "pending"
  },
  "result": {
    "deepfake_detection": {
      "channels": [
        {
          "channel_number": 0,
          "score": 0
        }
      ]
    }
  },
  "error": {
    "type": "internal",
    "message": "string",
    "detail": [
      {
        "location": [
          0,
          "string"
        ],
        "message": "string",
        "type": "string",
        "context": {}
      }
    ]
  }
}

task done

Authenticity Verification task done

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "done"
  },
  "result": {
    "deepfake_detection": {
      "channels": [
        {
          "channel_number": 0,
          "score": 9.7
        }
      ]
    }
  }
}

task rejected

Authenticity Verification task rejected

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "rejected"
  },
  "error": {
    "type": "task.validation-error",
    "message": "Task validation error.",
    "detail": []
  }
}

task failed

Authenticity Verification task failed

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "failed"
  },
  "error": {
    "type": "internal",
    "message": "Service error.",
    "detail": []
  }
}

400

Request payload data was invalid and could not be parsed.

application/json

Schema

Schema

type RequestErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]

Machine-readable error type.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.invalid

Invalid request.

{
  "type": "request.invalid",
  "message": "Invalid request.",
  "detail": []
}

404

The requested task does not exist.

The provided task_id may be wrong or the task may have expired already.

application/json

Schema

Schema

type RequestErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]

Machine-readable error type.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

not found

Task not found.

{
  "type": "resource.not-found",
  "message": "Resource not found.",
  "detail": [
    {
      "location": [
        "root"
      ],
      "message": "Task not found.",
      "type": "task.not-found",
      "context": {
        "task_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}

422

Error during validation of request payload data occurred.

application/json

Schema

Schema

type RequestErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]

Machine-readable error type.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request validation error

Request validation error.

{
  "type": "request.validation-error",
  "message": "Request validation error.",
  "detail": []
}

429

Request rate limit exceeded.

The request may be retried after a while. The following response headers may be checked for details: retry-after, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset.

Response Headers

• retry-after

  number

  Header indicates how long the user agent should wait before making a follow-up request.

• x-ratelimit-limit

  number

  Size of the current rate limiting window.

• x-ratelimit-remaining

  number

  Remaining number of requests in the current rate limiting window.

• x-ratelimit-reset

  number

  Time at which the current rate limiting window resets (in UTC epoch).

application/json

Schema

Schema

type RequestErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]

Machine-readable error type.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.rate-limit-exceeded

Rate limit exceeded.

{
  "type": "request.rate-limit-exceeded",
  "message": "Rate limit exceeded: 1 per 5 second.",
  "detail": []
}

Loading...