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_prompt_destroy

Request

API viewset for managing prompts.

This view allows tenant admins and students to create, retrieve, update, and filter prompts based on various parameters.

Permissions:

  • Accessible to both tenant administrators and students
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this prompt.

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 DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/?category=0&created_by=string&filter_by=string&mentor_unique_id=string&tag=0&visibility=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_prompt_orgs_users_prompts_category_retrieve

Request

Retrieve a list of prompt categories.

Query Parameters:

  • filter_by (optional): Sorts categories by name if set to "name".

Args: request: The HTTP request. org: Organization key identifier.

Returns:

  • 200: List of prompt categories.
  • 400: If query parameters are invalid.
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
filter_bystringnon-empty

Filter options include, date, name, default is date

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/?filter_by=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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_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" }

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations