Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_call_configurations_partial_update

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_call_configurations_update

Request

API ViewSet for managing call configurations.

This ViewSet provides endpoints to retrieve, create, and update call configurations for mentors. Call configurations define how voice calls are handled for a mentor.

Permissions:

  • Accessible only to platform admins.

Endpoints: GET /api/org/{org}/mentors/{mentor_pk}/call-configurations/

  • List all call configurations for a specific mentor
  • Returns paginated list of call configurations

POST /api/org/{org}/mentors/{mentor_pk}/call-configurations/

  • Create a new call configuration for a mentor
  • Requires call configuration data in request body

PUT /api/org/{org}/mentors/{mentor_pk}/call-configurations/{id}/

  • Update an existing call configuration
  • Requires call configuration data in request body

Query Parameters:

  • mentor: Filter configurations by mentor ID

Returns:

  • CallConfigurationSerializer data
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this call configuration.

orgstringrequired
user_idstringrequired
Body
required
mentorintegerrequired
modestring(CallConfigurationModeEnum)
  • realtime - Realtime
  • inference - Inference
Enum"realtime""inference"
tts_providerstring(TtsProviderEnum)
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
stt_providerstring(SttProviderEnum)
  • openai - Openai
  • google - Google
  • deepgram - Deepgram
  • cartesia - Cartesia
Enum"openai""google""deepgram""cartesia"
llm_providerstring(LlmProviderEnum)
  • openai - Openai
  • google - Google
Enum"openai""google"
use_function_calling_for_ragboolean

Whether to use function calls in the agent or force RAG calls before LLM generation

google_voiceobject(Voice)
openai_voiceobject(Voice)
openai_voice_idinteger or nullrequired
google_voice_idinteger or nullrequired
enable_videoboolean

Whether to enable video for the call. (applicable only for realtime mode)

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/call-configurations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mentor": 0,
    "mode": "realtime",
    "tts_provider": "openai",
    "stt_provider": "openai",
    "llm_provider": "openai",
    "use_function_calling_for_rag": true,
    "google_voice": {
      "name": "string",
      "provider": "openai",
      "language": "string",
      "description": "string"
    },
    "openai_voice": {
      "name": "string",
      "provider": "openai",
      "language": "string",
      "description": "string"
    },
    "openai_voice_id": 0,
    "google_voice_id": 0,
    "enable_video": true
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
mentorintegerrequired
modestring(CallConfigurationModeEnum)
  • realtime - Realtime
  • inference - Inference
Enum"realtime""inference"
tts_providerstring(TtsProviderEnum)
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
stt_providerstring(SttProviderEnum)
  • openai - Openai
  • google - Google
  • deepgram - Deepgram
  • cartesia - Cartesia
Enum"openai""google""deepgram""cartesia"
llm_providerstring(LlmProviderEnum)
  • openai - Openai
  • google - Google
Enum"openai""google"
use_function_calling_for_ragboolean

Whether to use function calls in the agent or force RAG calls before LLM generation

google_voiceobject(Voice)
openai_voiceobject(Voice)
openai_voice_idinteger or nullrequired
google_voice_idinteger or nullrequired
enable_videoboolean

Whether to enable video for the call. (applicable only for realtime mode)

platform_keystringread-onlyrequired
Response
application/json
{
  "id": 0,
  "mentor": 0,
  "mode": "realtime",
  "tts_provider": "openai",
  "stt_provider": "openai",
  "llm_provider": "openai",
  "use_function_calling_for_rag": true,
  "google_voice": {
    "id": 0,
    "name": "string",
    "provider": "openai",
    "language": "string",
    "description": "string",
    "audio_url": "string"
  },
  "openai_voice": {
    "id": 0,
    "name": "string",
    "provider": "openai",
    "language": "string",
    "description": "string",
    "audio_url": "string"
  },
  "openai_voice_id": 0,
  "google_voice_id": 0,
  "enable_video": true,
  "platform_key": "string"
}

ai_mentor_orgs_users_call_configurations_partial_update

Request

API ViewSet for managing call configurations.

This ViewSet provides endpoints to retrieve, create, and update call configurations for mentors. Call configurations define how voice calls are handled for a mentor.

Permissions:

  • Accessible only to platform admins.

Endpoints: GET /api/org/{org}/mentors/{mentor_pk}/call-configurations/

  • List all call configurations for a specific mentor
  • Returns paginated list of call configurations

POST /api/org/{org}/mentors/{mentor_pk}/call-configurations/

  • Create a new call configuration for a mentor
  • Requires call configuration data in request body

PUT /api/org/{org}/mentors/{mentor_pk}/call-configurations/{id}/

  • Update an existing call configuration
  • Requires call configuration data in request body

Query Parameters:

  • mentor: Filter configurations by mentor ID

Returns:

  • CallConfigurationSerializer data
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this call configuration.

orgstringrequired
user_idstringrequired
Body
mentorinteger
modestring(CallConfigurationModeEnum)
  • realtime - Realtime
  • inference - Inference
Enum"realtime""inference"
tts_providerstring(TtsProviderEnum)
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
stt_providerstring(SttProviderEnum)
  • openai - Openai
  • google - Google
  • deepgram - Deepgram
  • cartesia - Cartesia
Enum"openai""google""deepgram""cartesia"
llm_providerstring(LlmProviderEnum)
  • openai - Openai
  • google - Google
Enum"openai""google"
use_function_calling_for_ragboolean

Whether to use function calls in the agent or force RAG calls before LLM generation

google_voiceobject(Voice)
openai_voiceobject(Voice)
openai_voice_idinteger or null
google_voice_idinteger or null
enable_videoboolean

Whether to enable video for the call. (applicable only for realtime mode)

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/call-configurations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mentor": 0,
    "mode": "realtime",
    "tts_provider": "openai",
    "stt_provider": "openai",
    "llm_provider": "openai",
    "use_function_calling_for_rag": true,
    "google_voice": {
      "name": "string",
      "provider": "openai",
      "language": "string",
      "description": "string"
    },
    "openai_voice": {
      "name": "string",
      "provider": "openai",
      "language": "string",
      "description": "string"
    },
    "openai_voice_id": 0,
    "google_voice_id": 0,
    "enable_video": true
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
mentorintegerrequired
modestring(CallConfigurationModeEnum)
  • realtime - Realtime
  • inference - Inference
Enum"realtime""inference"
tts_providerstring(TtsProviderEnum)
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
stt_providerstring(SttProviderEnum)
  • openai - Openai
  • google - Google
  • deepgram - Deepgram
  • cartesia - Cartesia
Enum"openai""google""deepgram""cartesia"
llm_providerstring(LlmProviderEnum)
  • openai - Openai
  • google - Google
Enum"openai""google"
use_function_calling_for_ragboolean

Whether to use function calls in the agent or force RAG calls before LLM generation

google_voiceobject(Voice)
openai_voiceobject(Voice)
openai_voice_idinteger or nullrequired
google_voice_idinteger or nullrequired
enable_videoboolean

Whether to enable video for the call. (applicable only for realtime mode)

platform_keystringread-onlyrequired
Response
application/json
{
  "id": 0,
  "mentor": 0,
  "mode": "realtime",
  "tts_provider": "openai",
  "stt_provider": "openai",
  "llm_provider": "openai",
  "use_function_calling_for_rag": true,
  "google_voice": {
    "id": 0,
    "name": "string",
    "provider": "openai",
    "language": "string",
    "description": "string",
    "audio_url": "string"
  },
  "openai_voice": {
    "id": 0,
    "name": "string",
    "provider": "openai",
    "language": "string",
    "description": "string",
    "audio_url": "string"
  },
  "openai_voice_id": 0,
  "google_voice_id": 0,
  "enable_video": true,
  "platform_key": "string"
}

ai_mentor_orgs_users_category_groups_list

Request

Retrieve a list of Mentor Category Groups.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
audienceinteger
audience__namestring
orderingstring

Which field to use when ordering the results.

searchstring

A search term.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/category-groups/?audience=0&audience__name=string&ordering=string&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
namestring<= 255 charactersrequired
descriptionstringrequired
audienceobject(MentorAudience)required
audience.​idintegerread-onlyrequired
audience.​namestring<= 255 charactersrequired
audience.​descriptionstring or null<= 255 characters
date_createdstring(date-time)read-onlyrequired
categoriesArray of objects(MentorCategory)required
categories[].​idintegerread-onlyrequired
categories[].​namestring<= 255 charactersrequired
categories[].​descriptionstring or null<= 255 characters
categories[].​category_groupinteger or null
categories[].​audienceobject(MentorAudience)required
categories[].​audience.​idintegerread-onlyrequired
categories[].​audience.​namestring<= 255 charactersrequired
categories[].​audience.​descriptionstring or null<= 255 characters
categories[].​audiencesArray of objects(MentorAudience)required
categories[].​audiences[].​idintegerread-onlyrequired
categories[].​audiences[].​namestring<= 255 charactersrequired
categories[].​audiences[].​descriptionstring or null<= 255 characters
audiencesArray of objects(MentorAudience)required
audiences[].​idintegerread-onlyrequired
audiences[].​namestring<= 255 charactersrequired
audiences[].​descriptionstring or null<= 255 characters
]
Response
application/json
[
  [
    { … }
  ]
]

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