API Reference

Get all your requests

📘

Path: /request
Method: GET

  1. Headers
  2. Response

Go to "Get all your requests" endpoint documentation

Headers

apiKey string required

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

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

Response

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.

user_id string required

A unique identifier assigned to each user. This parameter is equal to your API key.

service_name string required

The service you want to use.

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 gives 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

For example,

[
  {
    "request_id": "2c29b988-1a24-45b4-a096-2cec2e887aa6",
    "user_id": "your_api_key",
    "service_name": "AMAZON",
    "request_type": "RECOGNITION",
    "request_status": "IN PROGRESS",
    "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"
  },
  {
    "request_id": "6470350f-0bbe-4a79-93a4-57555a921f15",
    "user_id": "your_api_key",
    "service_name": "GOOGLE",
    "request_type": "RECOGNITION",
    "request_status": "DONE",
    "data_uri": "https://my-audio-bucket.s3.eu-west-3.amazonaws.com/example.wav",
    "creation_time": "05/07/2021 08:12"
  },
  {
    "request_id": "756d205e-a4e8-402f-8090-bb45dd61c2fd",
    "user_id": "your_api_key",
    "service_name": "MICROSOFT",
    "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": "01/09/2021 09:04"
  }
]

Go to "Get all your requests" endpoint documentation