Skip to content
API Reference/
/
ai_mentor_orgs_users_mode...

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

ai_mentor_orgs_users_moderation_logs_retrieve

Request

Endpoint to view and delete Moderation Logs for a tenant.

These can be filtered by username, platform_key and mentor id

A search query can be conducted to search through the prompts and reason for the moderation catch event.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this moderation log.

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
usernamestring<= 200 characters
platform_keystring<= 200 charactersrequired
mentorintegerrequired
promptstringrequired
reasonstringrequired
target_systemstring(TargetSystemEnum)
  • Safety System - Safety System
  • Moderation System - Moderation System
Enum"Safety System""Moderation System"
date_createdstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "username": "string",
  "platform_key": "string",
  "mentor": 0,
  "prompt": "string",
  "reason": "string",
  "target_system": "Safety System",
  "date_created": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_moderation_logs_destroy

Request

Endpoint to view and delete Moderation Logs for a tenant.

These can be filtered by username, platform_key and mentor id

A search query can be conducted to search through the prompts and reason for the moderation catch event.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this moderation log.

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

Responses

No response body

ai_mentor_orgs_users_periodic_agent_logs_list

Request

Endpoint to view logs for periodic agent runs.

These logs contain the full mentor output for each run for debugging. Logs are ordered from newest to oldest. However this can be changed.

You can also filter logs for a PeriodicAgent by passing the periodic_agent query parameter in the URL.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
mentor_idstring
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

parent_mentor_idstring
parent_session_idstring
periodic_agentinteger
searchstring

A search term.

statusstring
  • success - Success
  • error - Error
  • running - Running
Enum"error""running""success"
usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/?mentor_id=string&ordering=string&page=0&page_size=0&parent_mentor_id=string&parent_session_id=string&periodic_agent=0&search=string&status=error&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(PeriodicAgentLog)required
results[].​idintegerread-onlyrequired
results[].​contentstring
results[].​statusstring(PeriodicAgentLogStatusEnum)
  • success - Success
  • error - Error
  • running - Running
Enum"success""error""running"
results[].​start_timestring(date-time)
results[].​end_timestring or null(date-time)
results[].​created_atstring(date-time)read-onlyrequired
results[].​modified_atstring(date-time)read-onlyrequired
results[].​periodic_agentintegerrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

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