Skip to content

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

ai-prompt

Operations

ai_prompt_orgs_users_prompts_category_create

Request

Create a new prompt category.

Args: request: The HTTP request containing category information. org: Organization key identifier. user_id: User performing the request.

Returns:

  • 201: Created prompt category.
  • 401: If the user is not a tenant admin.
  • 400: If request data is invalid.
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
namestring<= 255 charactersrequired
descriptionstring or null<= 255 characters
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

Created prompt category

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired
descriptionstring or null<= 255 characters
created_atstring or null(date-time)read-onlyrequired
updated_atstring or null(date-time)read-onlyrequired
Response
application/json
{ "id": 1, "name": "Education", "description": "Education-related prompts" }

ai_prompt_orgs_users_prompts_category_destroy

Request

Delete a prompt category.

Args: request: The HTTP request containing the category to delete. org: Organization key identifier. user_id: User performing the request.

Returns:

  • 204: No Content (successful deletion).
  • 401: If the user is not a tenant admin.
  • 400: If request data is invalid.
  • 404: If the category does not exist.
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Prompt category deleted successfully.

ai_prompt_orgs_users_prompts_public_list

Request

API viewset for managing prompts.

This view allows anyone to retrieve, and filter prompts based on various parameters.

Permissions:

  • Accessible to anyone
Path
orgstringrequired
user_idstringrequired
Query
categoryinteger

Category of the prompt

created_bystringnon-empty

Option to filter by username of the prompt creators.

filter_bystringnon-empty

Filter options include, date, prompt, default is date

mentor_unique_idstringnon-empty

Mentor unique id of the prompt

taginteger

Tag of the prompt

visibilitystringnon-empty

Visibility trype the mentor of the prompt

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/public/?category=0&created_by=string&filter_by=string&mentor_unique_id=string&tag=0&visibility=string'

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
mentorstring(uuid)
tonestring or null
stylestring
languagestring
tagsArray of integers
is_systemboolean
Default true
metadataany
categorystring
promptstringrequired
titlestring or null<= 255 characters
descriptionstring or null
prompt_visibility(PromptVisibilityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • viewable_by_tenant_admins - Viewable By Tenant Admins
  • viewable_by_tenant_students - Viewable By Tenant Students
  • viewable_by_anyone - Viewable By Anyone
string or null(PromptVisibilityEnum)
  • viewable_by_tenant_admins - Viewable By Tenant Admins
  • viewable_by_tenant_students - Viewable By Tenant Students
  • viewable_by_anyone - Viewable By Anyone
Enum"viewable_by_tenant_admins""viewable_by_tenant_students""viewable_by_anyone"
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
created_bystring or null<= 255 characters
platformintegerrequired
]
Response
application/json
[ { "id": 0, "mentor": "ecbf8dc6-e97d-4602-939f-cda86082faa0", "tone": "string", "style": "string", "language": "string", "tags": [], "is_system": true, "metadata": null, "category": "string", "prompt": "string", "title": "string", "description": "string", "prompt_visibility": "viewable_by_tenant_admins", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": "string", "platform": 0 } ]

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations