Get a request's information

📘

Path: /request/{request_id}
Method: GET

1. Path parameters
   • request_id
2. Headers
   • apiKey
3. Response
   • user_id
   • request_id
   • service_name
   • request_type
   • request_status
   • data_uri
   • endpoint
   • creation_time
   • output

Go to "Get a specific request, given its ID" endpoint documentation

---

Path parameters

request_id string required

The ID of the request you want to interact with. This ID will be given after posting a new request and can be found in the list of your request (that you can get here).

As a path parameter, the request ID must be put in the request URL.

For example,

Example

curl --request GET \
  --url https://api.hooho.io/request/your_request_id \
  --header 'apiKey: your_api_key'

---

Headers

apiKey string required

A valid Hooho API key, with enough credit to perform the request.

Example

curl --request GET \
  --url https://api.hooho.io/request/your_request_id \
  --header 'apiKey: your_api_key'

---

Response

user_id string required

A unique identifier for you in our server. Most of the time, this ID is your API key.

---

request_id string required

A unique identifier assigned at the creation of the request. You will be able to use this ID to interact with the request it refers to.

---

service_name string required

The service used for this request.

Possible values

• AMAZON
• GOOGLE
• MICROSOFT
• REV_AI
• SPEECHMATICS

---

request_type string required

The type of the request, corresponding to the job you want to do.

Possible values

• RECOGNITION
• ALIGNMENT

---

request_status string required

The status of the request.

Possible values

• PENDING
• IN PROGRESS
• DONE
• ERROR

---

data_uri string

The data URI you provided to Hooho, that give access to the file you want to process (which should follow these requirements)

---

endpoint string

Optionnal endpoint that will be called when the status of the request changes. A message similar to the GET /request/{requestId} response will be sent.

---

creation_time string

Date of the creation of the request at the format dd/MM/yyyy hh:mm

---

output hooho output

The output of your request. Based on the request status, the output can take different values.

Possible values

• no value (if request_status is PENDING or IN PROGRESS)
• details about the error (if request_status is ERROR)
• a standard Hooho output (if request_status is DONE)

For more information about the standard Hooho output, go to the "Hooho output" section.

For example,

Example

{
  "user_id": "your_api_key",
  "request_id": "2c29b988-1a24-45b4-a096-2cec2e887aa6",
  "service_name": "AMAZON",
  "request_type": "RECOGNITION",
  "request_status": "DONE",
  "data_uri": "https://my-audio-bucket.s3.eu-west-3.amazonaws.com/example.wav",
  "endpoint": "http://my_endpoint.io",
  "creation_time": "18/08/2021 13:52",
  "output": [
    {
      "transcript": "I use who oh. It makes things easier!",
      "phrases": [
        {
          "content": "I use who oh.",
          "type": "phrase",
          "start_time": 0,
          "end_time": 2.51,
          "items": [
            {
              "content": "I",
              "type": "word",
              "start_time": 0,
              "end_time": 0.39,
              "confidence": 1
            },
            {
              "word": "use",
              "start_time": 0.39,
              "end_time": 1.26,
              "confidence": 1
            },
            {
              "content": "who",
              "type": "word",
              "start_time": 1.26,
              "end_time": 1.96,
              "confidence": 1
            },
            {
              "content": "oh",
              "type": "word",
              "start_time": 1.96,
              "end_time": 2.51,
              "confidence": 1
            },
            {
              "content": ".",
              "type": "punctuation",
              "start_time": 2.51,
              "confidence": 1
            }
          ]
        },
        {
          "content": "It makes things easier.",
          "type": "phrase",
          "start_time": 2.51,
          "end_time": 5.38,
          "items": [
            {
              "content": "It",
              "type": "word",
              "start_time": 2.51,
              "end_time": 3.12,
              "confidence": 1
            },
            {
              "word": "makes",
              "start_time": 3.12,
              "end_time": 3.81,
              "confidence": 1
            },
            {
              "content": "things",
              "type": "word",
              "start_time": 3.81,
              "end_time": 4.33,
              "confidence": 1
            },
            {
              "content": "easier",
              "type": "word",
              "start_time": 4.33,
              "end_time": 5.38,
              "confidence": 1
            },
            {
              "content": "!",
              "type": "punctuation",
              "start_time": 5.38,
              "confidence": 1
            }
          ]
        }
      ],
      "wer_data": [
        {
          "reference": "I love Hooho. It makes things easier!",
          "wer": 0.2857142857142857
        }
      ],
      "wer_mean": 0.2857142857142857
    }
  ]
}

---

Go to "Get a specific request, given its ID" endpoint documentation