Speeches - Developers

Notes

Expert level

The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.

List

API endpoint:

GET

http://aicore.us/api/v1/speeches

Request example:

curl --location --request GET 'http://aicore.us/api/v1/speeches' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameter

Type

Description

search

optional string

The search query.

search_by

optional string

Search by. Possible values are: name for Name, content for Content. Defaults to: name.

voice

optional string

Filter by voice. Possible values are: alloy, echo, fable, onyx, nova, shimmer.

format

optional string

Filter by format. Possible values are: mp3, flac, aac, opus.

favorite

optional boolean

Filter by favorite.

sort_by

optional string

Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.

sort

optional string

Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.

per_page

optional integer

Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.

Show

API endpoint:

GET

http://aicore.us/api/v1/speeches/{id}

Request example:

curl --location --request GET 'http://aicore.us/api/v1/speeches/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Store

API endpoint:

POST

http://aicore.us/api/v1/speeches

Request example:

curl --location --request POST 'http://aicore.us/api/v1/speeches' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--form 'name={name}' \
--form 'file=@{file}'

Parameter

Type

Description

name

required string

The speech name.

content

required string

The content of the speech.

description

required string

The voice of the audio file. Possible values are: alloy, echo, fable, onyx, nova, shimmer.

format

required string

The format of the audio file. Possible values are: mp3, flac, aac, opus.

Update

API endpoint:

PUT PATCH

http://aicore.us/api/v1/speeches/{id}

Request example:

curl --location --request PUT 'http://aicore.us/api/v1/speeches/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameter

Type

Description

name

optional string

The speech name.

favorite

optional boolean

Whether the transcription is favorite or not.

Delete

API endpoint:

DELETE

http://aicore.us/api/v1/speeches/{id}

Request example:

curl --location --request DELETE 'http://aicore.us/api/v1/speeches/{id}' \
--header 'Authorization: Bearer {api_key}'