Getting your API key

Sign in to Hume
Copy your API key from the left panel on the home page.

📘
Your API key is a random sequence of letters and numbers.
It should look something like ntylOFypHLRXMmjlTxljoecAnMgB30JtOLZC2nph1TYErCvv

Your first API call

Let's start by trying out the facial expression model.
We'll use this picture of our friend, David Hume.

Starting a job

To run a job with the Hume Batch API, open a terminal window and run the following curl command: (make sure to replace with the actual API key you got in the steps above.

curl https://api.hume.ai/v0/batch/jobs
--request POST  
--header "Content-Type: application/json"  
--header "X-Hume-Api-Key: <YOUR-API-KEY>"  
--data '{  
    "urls": [  
        "https://iep.utm.edu/wp-content/media/hume-bust.jpg"  
    ],  
    "models": {  
        "face": {}  
    }  
}'

# Response
{
    "job_id": "6b5e7b4f21a247bd8247b91983f12d57"
}

from hume import HumeBatchClient
from hume.models.config import FaceConfig

client = HumeBatchClient("<YOUR-API-KEY>")
urls = ["https://iep.utm.edu/wp-content/media/hume-bust.jpg"]
config = FaceConfig()
job = client.submit_job(urls, [config])

Checking job status

Check the status of your job with another command: (replace both <YOUR-API-KEY> and <JOB-ID>)

curl --request GET \
     --url https://api.hume.ai/v0/batch/jobs/<JOB-ID> \
     --header 'X-Hume-Api-Key: <YOUR-API-KEY>' \
     --header 'accept: application/json; charset=utf-8'

# Response
{
    "job_id": "<JOB-ID>",
    "request": {...},
    "state": {
        "status": "COMPLETED",
        ...
    },
    "user_id": "<USER-ID>"
}

status = job.get_status()
print(f"Job status: {status}")

details = job.get_details()
run_time_ms = details.get_run_time_ms()
print(f"Job ran for {run_time_ms} milliseconds")

📘
If your job status is QUEUED or IN_PROGRESS you can wait a few seconds and try the last command again. Processing time may be slow based on job size and server load.

Your predictions

To retrieve your predictions: (replace both <YOUR-API-KEY> and <JOB-ID>)

curl --request GET \
     --url https://api.hume.ai/v0/batch/jobs/<JOB-ID>/predictions \
     --header 'X-Hume-Api-Key: <YOUR-API-KEY>' \
     --header 'accept: application/json; charset=utf-8'

from pprint import pprint

predictions = job.get_predictions()
pprint(predictions)

You can see the bounding box where the face was detected as well as a high-dimensional emotion embedding for the detected face.

{  
  "box": { "x": 94.045, "y": 38.421, "w": 66.237, "h": 86.245 },  
  "emotions": [  
    { "name": "Calmness", "score": 0.220 },  
    { "name": "Boredom", "score": 0.198 },  
    { "name": "Interest", "score": 0.185 }  
    # ... More emotions  
  ]