Run the Apollo model on existing recordings | Thymia

Create a new run of the Apollo model for a specific user. Model runs require two recordings:

A mood question recording - for example, the user’s response to “How are you feeling today?”
A read-aloud recording - for example, the user reading a standard passage

For assistance, please contact our support team.

The response contains:

Upload urls for both recordings which can be uploaded to via PUT requests
The id of the new model run which can be used to poll for results after both recordings have been uploaded

Note:

Both recordings must be uploaded for the model to start processing

Each recording must contain at least 15 seconds of speech and be under 3 minutes in length

Supported audio formats are FLAC, MP3, MP4, Ogg, WebM, WAV

Each upload URL is valid for 1 hour

Create a new run of the Apollo model for a specific user. Model runs require two recordings: 1. A mood question recording - for example, the user's response to "How are you feeling today?" 2. A read-aloud recording - for example, the user reading a standard passage - For assistance, please contact our support team. The response contains: * Upload urls for both recordings which can be uploaded to via `PUT` requests * The id of the new model run which can be used to poll for results **after both recordings have been uploaded** > **Note**: > * Both recordings must be uploaded for the model to start processing > * Each recording must contain at least 15 seconds of speech and be under 3 minutes in length > * Supported audio formats are FLAC, MP3, MP4, Ogg, WebM, WAV > * Each upload URL is valid for 1 hour

Authentication

x-api-keystring

Your API Activation Key

Request

This endpoint expects an object.

userobjectRequired

The user that this model run is being submitted for

languageenumRequired

The code of the language being spoken by the user in the recordings to be uploaded

deleteDatabooleanOptionalDefaults to false

Boolean flag indicating if user data is to be deleted after the completion of the model run. If True, the recordings, model inputs and model results will be deleted 12 hrs after the model run completes. Attempts to retrieve results after this time will receive a 404 error.

Response

Details of new model run created, including upload links for the two required recordings

idstringformat: "uuid"

The id of the newly created model run

uploadUrlsobject

Errors

Create a new run of the Apollo model for a specific user. Model runs require two recordings:

A mood question recording - for example, the user’s response to “How are you feeling today?”
A read-aloud recording - for example, the user reading a standard passage

For assistance, please contact our support team.

The response contains:

Upload urls for both recordings which can be uploaded to via PUT requests
The id of the new model run which can be used to poll for results after both recordings have been uploaded

Note:

Both recordings must be uploaded for the model to start processing

Each recording must contain at least 15 seconds of speech and be under 3 minutes in length

Supported audio formats are FLAC, MP3, MP4, Ogg, WebM, WAV

Each upload URL is valid for 1 hour

1	import requests
2
3	url = "https://api.example.com/v1/models/apollo"
4
5	payload = {
6	"user": {
7	"userLabel": "42baba59-fa4a-4a22-ba1c-2e4a88a3badb",
8	"dateOfBirth": "1990-08-24",
9	"birthSex": "MALE"
10	},
11	"language": "en-GB"
12	}
13	headers = {
14	"x-api-key": "<apiKey>",
15	"Content-Type": "application/json"
16	}
17
18	response = requests.post(url, json=payload, headers=headers)
19
20	print(response.json())

1	{
2	"id": "string",
3	"uploadUrls": {
4	"moodQuestionUploadUrl": "https://path/to/upload/mood",
5	"readAloudUploadUrl": "https://path/to/upload/read"
6	}
7	}