Check job status

Available in Classic and VPC

Check the job status of async (asynchronous) requests in long sentence recognition.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/recognizer/{token}

Request headers

For headers common to all CLOVA Speech APIs, see Common CLOVA Speech headers.

Request path parameters

The following describes the request path parameters.

Field	Type	Required	Description
`token`	String	Required	Result token

Request example

The following is a sample request.

curl --location --request GET 'https://clovaspeech-gw.ncloud.com/external/v1/88**/{InvokeKey}/recognizer/{token}' \
--header 'X-CLOVASPEECH-API-KEY: {Secret key issued when registering the app}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`result`	String	-	Status check result code `WAITING` \| `PROCESSING` \| `FAILED` \| `COMPLETED` \| `TIMEOUT` `WAITING`: requested job pending `PROCESSING`: requested job processing `FAILED`: requested job failed `COMPLETED`: requested job successful `TIMEOUT`: requested job timeout
`message`	String	-	Status check result message
`token`	String	-	Result token
`segments`	Array	-	See the `segments` details of Object Storage file recognition, External file recognition, and Local file recognition
`speakers`	Array	-	See the `speakers` details of Object Storage file recognition, External file recognition, and Local file recognition
`events`	Array	-	See the `events` details of Object Storage file recognition, External file recognition, and Local file recognition
`eventTypes`	Array	-	See the `eventTypes` details of Object Storage file recognition, External file recognition, and Local file recognition

Response status codes

For response status codes common to all CLOVA Speech APIs, see Common CLOVA Speech response status codes.

Response example

The following is a sample example.

Succeeded

The following is a sample response if the call is requested with async and is successful.

{
    "result": "COMPLETED",
    "token": "{token}",
    "segments": [],
    "speakers": [],
    "events": [],
    "eventTypes": []
}

Failure

The following is a sample response if the call is requested with sync and fails.

{
    "result": "ERROR_TOKEN_INVALID",
    "message": "Token does not exist",
    "token": "{token}",
    "segments": [],
    "speakers": [],
    "events": [],
    "eventTypes": []
}