Skip to content
API Reference
/
ai-prompt
/
ai_prompt_orgs_users_prompt_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

ai_prompt_orgs_users_prompt_create

Request

Create a new prompt.

Args: request: HTTP request containing prompt data.

Returns: Response with created prompt details.

Raises: ValidationError: If the input data is invalid.

Security
PlatformApiKeyAuthentication
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

Body
required
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_bystring or null<= 255 characters
platformintegerrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/?category=0&created_by=string&filter_by=string&mentor_unique_id=string&tag=0&visibility=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "What are the benefits of exercise?",
    "category": "health",
    "tags": [
      1,
      2
    ],
    "mentor": 3,
    "prompt_visibility": "viewable_by_anyone"
  }'

Responses

Bodyapplication/json
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
{
  "text": "What are the benefits of exercise?",
  "category": "health",
  "tags": [
    1,
    2
  ],
  "mentor": 3,
  "prompt_visibility": "viewable_by_anyone"
}

ai_prompt_orgs_users_prompt_retrieve

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 GET \
  '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

Bodyapplication/json
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": [
    0
  ],
  "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
}

ai_prompt_orgs_users_prompt_update

Request

Update an existing prompt.

Args: request: HTTP request containing updated prompt data.

Returns: Response with updated prompt details.

Raises: ValidationError: If the input data is invalid. PermissionDenied: If the prompt is system-generated and cannot be edited.

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

Body
required
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_bystring or null<= 255 characters
platformintegerrequired
curl -i -X PUT \
  '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' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "Updated prompt text",
    "category": "updated_category",
    "tags": [
      3,
      4
    ],
    "mentor": 1,
    "prompt_visibility": "viewable_by_admins"
  }'

Responses

Bodyapplication/json
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
{
  "text": "Updated prompt text",
  "category": "updated_category",
  "tags": [
    3,
    4
  ],
  "mentor": 1,
  "prompt_visibility": "viewable_by_admins"
}

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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