Skip to content
API Reference/
/
ai_media_orgs_users_heyge...

ibl-data-manager (4.84.1-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_media_orgs_users_heygen_video_download_retrieve

Request

Endpoint used to download a heygen video.

Only platform admins have access to this endpoint.

Security
PlatformApiKeyAuthentication
Path
heygen_marketing_video_idstringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-media/orgs/{org}/users/{user_id}/heygen/video-download/{heygen_marketing_video_id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_media_orgs_users_heygen_videos_list

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
pageinteger

A page number within the paginated result set.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-media/orgs/{org}/users/{user_id}/heygen/videos/?page=0' \
  -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(HeygenMarketingVideoList)required
results[].​namestring<= 1024 characters
results[].​dataany or null
results[].​pkinteger(ID)read-onlyrequired
results[].​generation_statusstringread-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_media_orgs_users_heygen_videos_create

Request

Endpoint to create a Heygen video

Only platform admins have access to this endpoint.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
scriptstringrequired
namestringrequired
template_idstring or null
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-media/orgs/{org}/users/{user_id}/heygen/videos/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "video name",
    "data": {},
    "script": "Hello world. this is a script.",
    "id": 35,
    "video_file": "https://example.com/abcd.mp4",
    "generation_status": "completed"
  }'

Responses

Bodyapplication/json
namestring<= 1024 characters
dataany or null
scriptstring or null
idintegerread-onlyrequired
video_filestring or nullread-onlyrequired
generation_statusstringread-onlyrequired
Response
application/json
{
  "name": "video name",
  "data": {},
  "script": "Hello world. this is a script.",
  "id": 35,
  "video_file": "https://example.com/abcd.mp4",
  "generation_status": "completed"
}

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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