Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_voices_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai_mentor_orgs_users_voices_list

Request

Retrieve a list of available voice options.

Args: request: The HTTP request.

Returns: Response: A list of available voice options.

Raises: NotFound: If no voice options are available.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

providerstring
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"elevenlabs""google""openai"
searchstring

A search term.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/voices/?ordering=string&page=0&page_size=0&provider=elevenlabs&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(Voice)required
results[].​idintegerread-onlyrequired
results[].​namestring<= 255 charactersrequired
results[].​providerstring(Provider637Enum)required
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
results[].​languagestring<= 255 characters
results[].​descriptionstring
results[].​audio_urlstringread-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [ … ]
  ]
}

ai_mentor_orgs_users_voices_retrieve

Request

Retrieve details of a specific voice option.

Args: request: The HTTP request. pk: The primary key of the voice option to retrieve.

Returns: Response: The details of the specified voice option.

Raises: NotFound: If the specified voice option does not exist.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this voice.

orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/voices/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired
providerstring(Provider637Enum)required
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
languagestring<= 255 characters
descriptionstring
audio_urlstringread-onlyrequired
Response
application/json
{
  "id": 1,
  "name": "Alloy",
  "provider": "openai",
  "gender": "female",
  "language": "en-US",
  "description": "A versatile, general-purpose voice"
}

ai_mentor_orgs_webhooks_azure_trigger_create

Request

Path
orgstringrequired
slugstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/webhooks/azure/trigger/{slug}/'

Responses

No response body

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com