Skip to content

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

API for iblai

Download OpenAPI description
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

Update an artifact

Request

Update all fields of an artifact (excluding chat_message reference).

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this artifact.

orgstringrequired
user_idstringrequired
Bodyrequired
titlestring<= 255 charactersrequired

Title or identifier for the artifact

contentstringrequired

The markdown-styled content of the artifact

metadataany

Additional metadata for the artifact

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/artifacts/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "content": "string",
    "metadata": null
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
titlestring<= 255 charactersrequired

Title or identifier for the artifact

contentstringrequired

The markdown-styled content of the artifact

file_extensionstringread-onlyrequired

The extension of the file for the artifact. eg. py, md, html, json, csv, etc

chat_messageintegerread-onlyrequired
llm_namestringread-onlyrequired
llm_providerstringread-onlyrequired
date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)read-onlyrequired
metadataany

Additional metadata for the artifact

usernamestringread-onlyrequired

Username of the student who owns this artifact

session_idstring(uuid)read-onlyrequired

UUID of the session that generated this artifact

Response
application/json
{ "id": 0, "title": "string", "content": "string", "file_extension": "string", "chat_message": 0, "llm_name": "string", "llm_provider": "string", "date_created": "2019-08-24T14:15:22Z", "date_updated": "2019-08-24T14:15:22Z", "metadata": null, "username": "string", "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82" }

Partially update an artifact

Request

Update specific fields of an artifact.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this artifact.

orgstringrequired
user_idstringrequired
Body
titlestring<= 255 characters

Title or identifier for the artifact

contentstring

The markdown-styled content of the artifact

metadataany

Additional metadata for the artifact

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/artifacts/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "content": "string",
    "metadata": null
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
titlestring<= 255 charactersrequired

Title or identifier for the artifact

contentstringrequired

The markdown-styled content of the artifact

file_extensionstringread-onlyrequired

The extension of the file for the artifact. eg. py, md, html, json, csv, etc

chat_messageintegerread-onlyrequired
llm_namestringread-onlyrequired
llm_providerstringread-onlyrequired
date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)read-onlyrequired
metadataany

Additional metadata for the artifact

usernamestringread-onlyrequired

Username of the student who owns this artifact

session_idstring(uuid)read-onlyrequired

UUID of the session that generated this artifact

Response
application/json
{ "id": 0, "title": "string", "content": "string", "file_extension": "string", "chat_message": 0, "llm_name": "string", "llm_provider": "string", "date_created": "2019-08-24T14:15:22Z", "date_updated": "2019-08-24T14:15:22Z", "metadata": null, "username": "string", "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82" }

Delete an artifact

Request

Delete a specific artifact.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this artifact.

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

Responses

Artifact deleted successfully

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