Skip to content
API Reference
/
media
/
media_orgs_users_media_media_resources_by_item_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-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

media_orgs_users_media_media_resources_list

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/?course_id=string&item_id=string&page=0&page_size=0&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_create

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

Body
required
titlestring<= 255 charactersrequired

Title of the media resource

descriptionstring or null

Description of the media resource

media_typestringrequired
  • video - Video
  • image - Image
  • document - Document
  • audio - Audio
  • other - Other
Enum"video""image""document""audio""other"
course_idstring or null<= 255 characters

ID of the associated course

unit_idstring or null<= 255 characters

ID of the associated unit

item_idstring or null<= 255 characters

ID of the associated item (resource)

file_urlstring or null(uri)<= 1000 characters

External URL for the media resource

filestring or null(uri)

Uploaded media file

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/?course_id=string&item_id=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "media_type": "video",
    "course_id": "string",
    "unit_id": "string",
    "item_id": "string",
    "file_url": "http://example.com",
    "file": "http://example.com"
  }'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_retrieve

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Media Resource.

orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/?course_id=string&item_id=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_update

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Media Resource.

orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

Body
required
titlestring<= 255 charactersrequired

Title of the media resource

descriptionstring or null

Description of the media resource

media_typestringrequired
  • video - Video
  • image - Image
  • document - Document
  • audio - Audio
  • other - Other
Enum"video""image""document""audio""other"
course_idstring or null<= 255 characters

ID of the associated course

unit_idstring or null<= 255 characters

ID of the associated unit

item_idstring or null<= 255 characters

ID of the associated item (resource)

file_urlstring or null(uri)<= 1000 characters

External URL for the media resource

filestring or null(uri)

Uploaded media file

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/?course_id=string&item_id=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "media_type": "video",
    "course_id": "string",
    "unit_id": "string",
    "item_id": "string",
    "file_url": "http://example.com",
    "file": "http://example.com"
  }'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_partial_update

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Media Resource.

orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

Body
titlestring<= 255 characters

Title of the media resource

descriptionstring or null

Description of the media resource

media_typestring
  • video - Video
  • image - Image
  • document - Document
  • audio - Audio
  • other - Other
Enum"video""image""document""audio""other"
course_idstring or null<= 255 characters

ID of the associated course

unit_idstring or null<= 255 characters

ID of the associated unit

item_idstring or null<= 255 characters

ID of the associated item (resource)

file_urlstring or null(uri)<= 1000 characters

External URL for the media resource

filestring or null(uri)

Uploaded media file

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/?course_id=string&item_id=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "media_type": "video",
    "course_id": "string",
    "unit_id": "string",
    "item_id": "string",
    "file_url": "http://example.com",
    "file": "http://example.com"
  }'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_destroy

Request

List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Media Resource.

orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstring

Filter by item ID

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/?course_id=string&item_id=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved media resources

media_orgs_users_media_media_resources_by_item_retrieve

Request

Get media resources for a specific item. The item_type determines which resources are returned based on the provided item_id.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter by course ID (e.g., course-v1:main+NB101+2025-T1)

item_idstringrequired

ID of the item

item_typestringrequired

Type of item. Valid values: course, unit, resource, course_unit, course_resource, unit_resource, all

Enum"all""course""course_resource""course_unit""resource""unit""unit_resource"
searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/by_item/?course_id=string&item_id=string&item_type=all&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved media resources for item

media_orgs_users_media_media_resources_search_retrieve

Request

Search media resources by title, description, or IDs. Supports filtering results by course_id, unit_id, and item_id.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired

Organization identifier

user_idstringrequired

User identifier

Query
course_idstring

Filter results by course ID

item_idstring

Filter results by item ID

qstringrequired

Search query string

searchstring

Search across title, description, course_id, unit_id, item_id, and file_url

unit_idstring

Filter results by unit ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/media/orgs/{org}/users/{user_id}/media/media-resources/search/?course_id=string&item_id=string&q=string&search=string&unit_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully searched media resources

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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