Voice Activity Detection: get result

GET 
/api/technology/voice-activity-detection/:task_id

Retrieve the result of a Voice Activity Detection task.

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.
Default value:
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.
Default value:

Responses

200

Result response of Voice Activity Detection 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 objectrequired
task_iduuidrequired
stateTaskInfoState (string)required
Possible values: [pending, running, rejected, failed, done]
result object
Result of Voice Activity Detection task.
channels object[]required
Array [
channel_numberChannel Number (integer)required
Channel number (0-base indexed).
Possible values: >= 0
speech_lengthSpeech Length (number)required
Length of speech in seconds in the channel detected by Voice Activity Detection.
Possible values: >= 0
segments object[]required
The list of segments detected by Voice Activity Detection, each containing a segment type and the time boundaries of the segment.
Array [
segment_typeSegment Type (string)required
Type of segment detected by Voice Activity Detection.
start_timeStart Time (number)required
Start time of the segment in seconds.
Possible values: >= 0
end_timeEnd Time (number)required
End time of the segment in seconds.
Possible values: >= 0
]
]
error object
Result schema for a failed or rejected task.
typeTaskErrorType (string)required
Machine-readable error type.
Possible values: [internal, task.validation-error]
messageMessage (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
]
messageMessage (string)required
Human-readable summary of the error.
typeType (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 (auto)

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

task done

Voice Activity Detection task done

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "done"
  },
  "result": {
    "channels": [
      {
        "channel_number": 0,
        "speech_length": 61.76,
        "segments": [
          {
            "segment_type": "voice",
            "start_time": 3.43,
            "end_time": 7.4
          },
          {
            "segment_type": "voice",
            "start_time": 20.21,
            "end_time": 24.98
          },
          {
            "segment_type": "voice",
            "start_time": 25.63,
            "end_time": 34.29
          },
          {
            "segment_type": "voice",
            "start_time": 36.87,
            "end_time": 41.87
          },
          {
            "segment_type": "voice",
            "start_time": 53.49,
            "end_time": 60.43
          },
          {
            "segment_type": "voice",
            "start_time": 61.43,
            "end_time": 74.32
          },
          {
            "segment_type": "voice",
            "start_time": 80.07,
            "end_time": 86.43
          },
          {
            "segment_type": "voice",
            "start_time": 97.32,
            "end_time": 103.19
          },
          {
            "segment_type": "voice",
            "start_time": 104.43,
            "end_time": 111.73
          }
        ]
      },
      {
        "channel_number": 1,
        "speech_length": 21.82,
        "segments": [
          {
            "segment_type": "voice",
            "start_time": 8.93,
            "end_time": 12.43
          },
          {
            "segment_type": "voice",
            "start_time": 14.89,
            "end_time": 19.18
          },
          {
            "segment_type": "voice",
            "start_time": 24.78,
            "end_time": 27.02
          },
          {
            "segment_type": "voice",
            "start_time": 43.69,
            "end_time": 48.81
          },
          {
            "segment_type": "voice",
            "start_time": 87.43,
            "end_time": 90.18
          },
          {
            "segment_type": "voice",
            "start_time": 92.4,
            "end_time": 96.32
          }
        ]
      }
    ]
  }
}

task rejected

Voice Activity Detection task rejected

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

task failed

Voice Activity Detection 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

typeRequestErrorType (string)required
Machine-readable error type.
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]
messageMessage (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
]
messageMessage (string)required
Human-readable summary of the error.
typeType (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 (auto)

{
  "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

typeRequestErrorType (string)required
Machine-readable error type.
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]
messageMessage (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
]
messageMessage (string)required
Human-readable summary of the error.
typeType (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 (auto)

{
  "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

typeRequestErrorType (string)required
Machine-readable error type.
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]
messageMessage (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
]
messageMessage (string)required
Human-readable summary of the error.
typeType (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 (auto)

{
  "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

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

x-ratelimit-limit

Size of the current rate limiting window.

x-ratelimit-remaining

Remaining number of requests in the current rate limiting window.

x-ratelimit-reset

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

application/json

Schema

Schema

typeRequestErrorType (string)required
Machine-readable error type.
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]
messageMessage (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
]
messageMessage (string)required
Human-readable summary of the error.
typeType (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 (auto)

{
  "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": []
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP