Skip to content
API Reference/
/
Retrieve an artifact

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-mentor

Operations

List artifacts

Request

Retrieve a paginated list of artifacts for a user, with optional filtering and search.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
chat_message_idstring(uuid)

Filter by specific chat message UUID

file_extensionstring

Filter by file extension (e.g., 'py', 'md', 'html')

llm_namestring

Filter by LLM name (e.g., 'gpt-4', 'claude-3')

llm_providerstring

Filter by LLM provider (e.g., 'openai', 'anthropic')

mentor_idstring(uuid)

Filter by mentor UUID

orderingstring

Order by field (prefix with - for descending). Options: date_created, date_updated, title

pageinteger

Page number

page_sizeinteger

Number of items per page (max: 100)

searchstring

Search in title and content

session_idstring(uuid)

Filter by session UUID

usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/artifacts/?chat_message_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&file_extension=string&llm_name=string&llm_provider=string&mentor_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&ordering=string&page=0&page_size=0&search=string&session_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&username=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(ArtifactList)required
results[].​idintegerread-onlyrequired
results[].​titlestringread-onlyrequired

Title or identifier for the artifact

results[].​file_extensionstringread-onlyrequired

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

results[].​llm_namestringread-onlyrequired
results[].​llm_providerstringread-onlyrequired
results[].​date_createdstring(date-time)read-onlyrequired
results[].​date_updatedstring(date-time)read-onlyrequired
results[].​usernamestringread-onlyrequired

Username of the student who owns this artifact

results[].​session_idstring(uuid)read-onlyrequired

UUID of the session that generated this artifact

results[].​content_lengthintegerread-onlyrequired

Length of the artifact content in characters

Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

Retrieve an artifact

Request

Get detailed information about a specific artifact including its full content.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this artifact.

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

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": 1,
  "title": "Python Calculator",
  "content": "```python\ndef add(a, b):\n    return a + b\n```",
  "file_extension": "py",
  "chat_message": "550e8400-e29b-41d4-a716-446655440001",
  "llm_name": "gpt-4",
  "llm_provider": "openai",
  "date_created": "2024-01-15T10:30:00Z",
  "date_updated": "2024-01-15T10:30:00Z",
  "metadata": {},
  "username": "johndoe",
  "session_id": "550e8400-e29b-41d4-a716-446655440000"
}

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
Body
required
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"
}

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