ai_mentor_orgs_users_periodic_agents

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_periodic_agents_list

Request

Endpoint to create and view, update and delete periodic agents.

Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent.

Access to these are restricted to platform admins and tenant administrators

Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent.

A Periodic Agent is allowed to have a callback_url and callback_secret. When a callback_url is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure:

{
    "timestamp": "timestamp when the run completed",
    "status": "status of the periodic agent",
    "prompt": "input prompt to agent,
    "agent_output": "...final response of agent",
    "log": "... full agent run log",
    "log_id": periodic agent log id.,
}

The payload is encrypted using the callback_secret provided.

You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body.

import hmac
import haslib

def validate_payload(request: HttpRequest, callback_secret: str):
    # Get the X-Hub-Signature-256 header from the request
    received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")

    if not received_signature.startswith("sha256="):
        # Invalid signature format
        return False

    received_signature = received_signature[len("sha256=") :]

    try:
        # Get the raw request body
        payload = request.body

        # Compute the expected signature using the app_secret
        expected_signature = hmac.new(
            callback_secret.encode(), payload, hashlib.sha256
        ).hexdigest()

        if hmac.compare_digest(received_signature, expected_signature):
            # Signatures match, the payload is genuine
            return True
        else:
            # Signatures don't match
            return False
    except Exception as e:
        # Handle any errors that may occur during validation
        return False

Security

PlatformApiKeyAuthentication

Path

orgstringrequired

user_idstringrequired

Query

enabledboolean

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_idinteger

parent_session_idstring

previous_agentinteger

previous_agent_statusstring

The status that the previous agent must be in before this agent gets scheduled.

success - Success
error - Error
running - Running
pending - Pending

Enum"error""pending""running""success"

searchstring

A search term.

statusstring

success - Success
error - Error
running - Running
pending - Pending

Enum"error""pending""running""success"

titlestring

usernamestring

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/?enabled=true&ordering=string&page=0&page_size=0&parent_mentor_id=0&parent_session_id=string&previous_agent=0&previous_agent_status=error&search=string&status=error&title=string&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(PeriodicAgent)required

results[].idintegerread-onlyrequired

results[].mentorobject(Mentor)required

results[].mentor.namestring<= 255 charactersrequired

results[].mentor.unique_idstring(uuid)

results[].mentor.flowanyrequired

The langflow json for the mentor

results[].mentor.slugstring<= 255 characters^[-a-zA-Z0-9_]+$

results[].mentor.platformstring<= 255 characters

results[].mentor.allow_anonymousboolean

results[].mentor.metadataany or null

results[].mentor.enable_moderationboolean

results[].mentor.enable_post_processing_systemboolean

results[].mentor.enable_openai_assistantboolean

(Deprecated) Set template mentor to openai-agent instead.

results[].mentor.enable_total_groundingboolean

Whether to force mentor to only use information within the provided documents.

results[].mentor.enable_suggested_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.

results[].mentor.enable_guided_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.

results[].mentor.guided_prompt_instructionsstring

Instructions to determine how prompt suggestions are generated.

results[].mentor.google_voiceinteger or null

results[].mentor.openai_voiceinteger or null

results[].mentor.categoriesArray of objects(MentorCategory)required

results[].mentor.categories[].idintegerread-onlyrequired

results[].mentor.categories[].namestring<= 255 charactersrequired

results[].mentor.categories[].descriptionstring or null<= 255 characters

results[].mentor.categories[].category_groupinteger or null

results[].mentor.categories[].audienceobject(MentorAudience)required

results[].mentor.categories[].audience.idintegerread-onlyrequired

results[].mentor.categories[].audience.namestring<= 255 charactersrequired

results[].mentor.categories[].audience.descriptionstring or null<= 255 characters

results[].mentor.categories[].audiencesArray of objects(MentorAudience)required

results[].mentor.categories[].audiences[].idintegerread-onlyrequired

results[].mentor.categories[].audiences[].namestring<= 255 charactersrequired

results[].mentor.categories[].audiences[].descriptionstring or null<= 255 characters

results[].mentor.proactive_promptstring

Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally

results[].mentor.moderation_system_promptstring

The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.

results[].mentor.post_processing_promptstring

Prompt to be used to alter or modify final llm response into any desired form.

results[].mentor.moderation_responsestring

Desired feedback to return to the user when their prompt is deemed inappropriate.

results[].mentor.safety_system_promptstring

Prompt to check whether the models response is appropriate or not.

results[].mentor.safety_responsestring

Feedback given to the user when a model generates an inappropriate response

results[].mentor.enable_safety_systemboolean

results[].mentor.proactive_responsestring

Response to start a conversation with a user.

results[].mentor.greeting_methodstring

proactive_prompt - Proactive Prompt
proactive_response - Proactive Response

Enum"proactive_prompt""proactive_response"

results[].mentor.call_configurationobject(CallConfiguration)

results[].mentor.mcp_serversArray of objects(MCPServer)required

results[].mentor.mcp_servers[].idintegerread-onlyrequired

results[].mentor.mcp_servers[].platformintegerread-onlyrequired

results[].mentor.mcp_servers[].namestring<= 255 charactersrequired

results[].mentor.mcp_servers[].urlstring(uri)<= 200 charactersrequired

The url of the MCP server.

results[].mentor.mcp_servers[].transportstring(TransportEnum)

sse - Sse
websocket - Websocket

Enum"sse""websocket"

results[].mentor.mcp_servers[].headersany

Headers to send to the MCP server. Useful for authentication,

results[].mentor.mcp_servers[].platform_keystringread-onlyrequired

results[].mentor.mcp_servers[].created_atstring(date-time)read-onlyrequired

results[].mentor.mcp_servers[].updated_atstring(date-time)read-onlyrequired

results[].mentor.last_accessed_byinteger or null[ 0 .. 2147483647 ]

edX user ID

results[].mentor.recently_accessed_atstring or null(date-time)

results[].mentor.created_bystring or null<= 255 characters

results[].mentor.created_atstring or null(date-time)read-onlyrequired

results[].mentor.updated_atstring or null(date-time)read-onlyrequired

results[].titlestring<= 255 charactersrequired

results[].usernamestringread-onlyrequired

results[].descriptionstring

results[].promptstring

Prompt for the periodic agent if any.

results[].taskobject(PeriodicTask)required

results[].task.idintegerread-onlyrequired

results[].task.namestringread-onlyrequired

Short Description For This Task

results[].task.crontabobject(CrontabSchedule)required

results[].task.crontab.minutestring(Minute(s))<= 240 characters

Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

results[].task.crontab.hourstring(Hour(s))<= 96 characters

Cron Hours to Run. Use "*" for "all". (Example: "8,20")

results[].task.crontab.day_of_weekstring(Day(s) Of The Week)<= 64 characters

Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")

results[].task.crontab.day_of_monthstring(Day(s) Of The Month)<= 124 characters

Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

results[].task.crontab.month_of_yearstring(Month(s) Of The Year)<= 64 characters

Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")

results[].task.one_offboolean(One-off Task)

If True, the schedule will only run the task a single time

results[].task.start_timestring or null(date-time)(Start Datetime)

Datetime when the schedule should begin triggering the task to run

results[].task.enabledboolean

Set to False to disable the schedule

results[].created_atstring(date-time)read-onlyrequired

results[].modified_atstring(date-time)read-onlyrequired

results[].enabledbooleanread-onlyrequired

results[].one_offbooleanread-onlyrequired

results[].platform_keystringread-onlyrequired

results[].pathwaystring<= 255 characters

results[].callback_urlstring(uri)<= 200 characters

results[].callback_secretstring<= 255 characters

results[].parent_session_idstring<= 200 characters

results[].parent_mentor_idinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]

results[].previous_agentinteger or null

Agent that needs to run before the current agent runs.

results[].previous_agent_statusstring

success - Success
error - Error
running - Running
pending - Pending

Enum"success""error""running""pending"

results[].previous_agent_outputstringread-onlyrequired

This will be fed into the run of this agent as part of its input prompt.

Response

application/json

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

ai_mentor_orgs_users_periodic_agents_create

Request

Endpoint to create and view, update and delete periodic agents.

Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent.

Access to these are restricted to platform admins and tenant administrators

Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent.

A Periodic Agent is allowed to have a callback_url and callback_secret. When a callback_url is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure:

{
    "timestamp": "timestamp when the run completed",
    "status": "status of the periodic agent",
    "prompt": "input prompt to agent,
    "agent_output": "...final response of agent",
    "log": "... full agent run log",
    "log_id": periodic agent log id.,
}

The payload is encrypted using the callback_secret provided.

You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body.

import hmac
import haslib

def validate_payload(request: HttpRequest, callback_secret: str):
    # Get the X-Hub-Signature-256 header from the request
    received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")

    if not received_signature.startswith("sha256="):
        # Invalid signature format
        return False

    received_signature = received_signature[len("sha256=") :]

    try:
        # Get the raw request body
        payload = request.body

        # Compute the expected signature using the app_secret
        expected_signature = hmac.new(
            callback_secret.encode(), payload, hashlib.sha256
        ).hexdigest()

        if hmac.compare_digest(received_signature, expected_signature):
            # Signatures match, the payload is genuine
            return True
        else:
            # Signatures don't match
            return False
    except Exception as e:
        # Handle any errors that may occur during validation
        return False

Security

PlatformApiKeyAuthentication

Path

orgstringrequired

user_idstringrequired

Body

required

mentorintegerrequired

titlestring<= 255 charactersrequired

descriptionstring

promptstring

Prompt for the periodic agent if any.

taskobject(PeriodicTask)required

task.crontabobject(CrontabSchedule)required

task.crontab.minutestring(Minute(s))<= 240 characters

Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

task.crontab.hourstring(Hour(s))<= 96 characters

Cron Hours to Run. Use "*" for "all". (Example: "8,20")

task.crontab.day_of_weekstring(Day(s) Of The Week)<= 64 characters

Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")

task.crontab.day_of_monthstring(Day(s) Of The Month)<= 124 characters

Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

task.crontab.month_of_yearstring(Month(s) Of The Year)<= 64 characters

Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")

task.one_offboolean(One-off Task)

If True, the schedule will only run the task a single time

task.start_timestring or null(date-time)(Start Datetime)

Datetime when the schedule should begin triggering the task to run

task.enabledboolean

Set to False to disable the schedule

pathwaystring<= 255 characters

callback_urlstring(uri)<= 200 characters

callback_secretstring<= 255 characters

parent_session_idstring<= 200 characters

parent_mentor_idinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]

previous_agentinteger or null

Agent that needs to run before the current agent runs.

previous_agent_statusstring

success - Success
error - Error
running - Running
pending - Pending

Enum"success""error""running""pending"

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mentor": 0,
    "title": "string",
    "description": "string",
    "prompt": "string",
    "task": {
      "crontab": {
        "minute": "string",
        "hour": "string",
        "day_of_week": "string",
        "day_of_month": "string",
        "month_of_year": "string"
      },
      "one_off": true,
      "start_time": "2019-08-24T14:15:22Z",
      "enabled": true
    },
    "pathway": "string",
    "callback_url": "http://example.com",
    "callback_secret": "string",
    "parent_session_id": "string",
    "parent_mentor_id": -9223372036854776000,
    "previous_agent": 0,
    "previous_agent_status": "success"
  }'

Responses

Bodyapplication/json

idintegerread-onlyrequired

mentorintegerrequired

titlestring<= 255 charactersrequired

usernamestringread-onlyrequired

descriptionstring

promptstring

Prompt for the periodic agent if any.

taskobject(PeriodicTask)required

task.idintegerread-onlyrequired

task.namestringread-onlyrequired

Short Description For This Task

task.crontabobject(CrontabSchedule)required

task.crontab.minutestring(Minute(s))<= 240 characters

Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

task.crontab.hourstring(Hour(s))<= 96 characters

Cron Hours to Run. Use "*" for "all". (Example: "8,20")

task.crontab.day_of_weekstring(Day(s) Of The Week)<= 64 characters

Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")

task.crontab.day_of_monthstring(Day(s) Of The Month)<= 124 characters

Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

task.crontab.month_of_yearstring(Month(s) Of The Year)<= 64 characters

Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")

task.one_offboolean(One-off Task)

If True, the schedule will only run the task a single time

task.start_timestring or null(date-time)(Start Datetime)

Datetime when the schedule should begin triggering the task to run

task.enabledboolean

Set to False to disable the schedule

created_atstring(date-time)read-onlyrequired

modified_atstring(date-time)read-onlyrequired

enabledbooleanread-onlyrequired

one_offbooleanread-onlyrequired

platform_keystringread-onlyrequired

pathwaystring<= 255 characters

callback_urlstring(uri)<= 200 characters

callback_secretstring<= 255 characters

parent_session_idstring<= 200 characters

parent_mentor_idinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]

previous_agentinteger or null

Agent that needs to run before the current agent runs.

previous_agent_statusstring

success - Success
error - Error
running - Running
pending - Pending

Enum"success""error""running""pending"

previous_agent_outputstringread-onlyrequired

This will be fed into the run of this agent as part of its input prompt.

Response

application/json

{
  "id": 0,
  "mentor": 0,
  "title": "string",
  "username": "string",
  "description": "string",
  "prompt": "string",
  "task": {
    "id": 0,
    "name": "string",
    "crontab": { … },
    "one_off": true,
    "start_time": "2019-08-24T14:15:22Z",
    "enabled": true
  },
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "one_off": true,
  "platform_key": "string",
  "pathway": "string",
  "callback_url": "http://example.com",
  "callback_secret": "string",
  "parent_session_id": "string",
  "parent_mentor_id": -9223372036854776000,
  "previous_agent": 0,
  "previous_agent_status": "success",
  "previous_agent_output": "string"
}

ai_mentor_orgs_users_periodic_agents_retrieve

Request

Endpoint to create and view, update and delete periodic agents.

Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent.

Access to these are restricted to platform admins and tenant administrators

Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent.

A Periodic Agent is allowed to have a callback_url and callback_secret. When a callback_url is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure:

{
    "timestamp": "timestamp when the run completed",
    "status": "status of the periodic agent",
    "prompt": "input prompt to agent,
    "agent_output": "...final response of agent",
    "log": "... full agent run log",
    "log_id": periodic agent log id.,
}

The payload is encrypted using the callback_secret provided.

You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body.

import hmac
import haslib

def validate_payload(request: HttpRequest, callback_secret: str):
    # Get the X-Hub-Signature-256 header from the request
    received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")

    if not received_signature.startswith("sha256="):
        # Invalid signature format
        return False

    received_signature = received_signature[len("sha256=") :]

    try:
        # Get the raw request body
        payload = request.body

        # Compute the expected signature using the app_secret
        expected_signature = hmac.new(
            callback_secret.encode(), payload, hashlib.sha256
        ).hexdigest()

        if hmac.compare_digest(received_signature, expected_signature):
            # Signatures match, the payload is genuine
            return True
        else:
            # Signatures don't match
            return False
    except Exception as e:
        # Handle any errors that may occur during validation
        return False

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this periodic agent.

orgstringrequired

user_idstringrequired

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

Responses

Bodyapplication/json

idintegerread-onlyrequired

mentorobject(Mentor)required

mentor.namestring<= 255 charactersrequired

mentor.unique_idstring(uuid)

mentor.flowanyrequired

The langflow json for the mentor

mentor.slugstring<= 255 characters^[-a-zA-Z0-9_]+$

mentor.platformstring<= 255 characters

mentor.allow_anonymousboolean

mentor.metadataany or null

mentor.enable_moderationboolean

mentor.enable_post_processing_systemboolean

mentor.enable_openai_assistantboolean

(Deprecated) Set template mentor to openai-agent instead.

mentor.enable_total_groundingboolean

Whether to force mentor to only use information within the provided documents.

mentor.enable_suggested_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.

mentor.enable_guided_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.

mentor.guided_prompt_instructionsstring

Instructions to determine how prompt suggestions are generated.

mentor.google_voiceinteger or null

mentor.openai_voiceinteger or null

mentor.categoriesArray of objects(MentorCategory)required

mentor.categories[].idintegerread-onlyrequired

mentor.categories[].namestring<= 255 charactersrequired

mentor.categories[].descriptionstring or null<= 255 characters

mentor.categories[].category_groupinteger or null

mentor.categories[].audienceobject(MentorAudience)required

mentor.categories[].audience.idintegerread-onlyrequired

mentor.categories[].audience.namestring<= 255 charactersrequired

mentor.categories[].audience.descriptionstring or null<= 255 characters

mentor.categories[].audiencesArray of objects(MentorAudience)required

mentor.categories[].audiences[].idintegerread-onlyrequired

mentor.categories[].audiences[].namestring<= 255 charactersrequired

mentor.categories[].audiences[].descriptionstring or null<= 255 characters

mentor.proactive_promptstring

Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally

mentor.moderation_system_promptstring

The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.

mentor.post_processing_promptstring

Prompt to be used to alter or modify final llm response into any desired form.

mentor.moderation_responsestring

Desired feedback to return to the user when their prompt is deemed inappropriate.

mentor.safety_system_promptstring

Prompt to check whether the models response is appropriate or not.

mentor.safety_responsestring

Feedback given to the user when a model generates an inappropriate response

mentor.enable_safety_systemboolean

mentor.proactive_responsestring

Response to start a conversation with a user.

mentor.greeting_methodstring

proactive_prompt - Proactive Prompt
proactive_response - Proactive Response

Enum"proactive_prompt""proactive_response"

mentor.call_configurationobject(CallConfiguration)

mentor.mcp_serversArray of objects(MCPServer)required

mentor.mcp_servers[].idintegerread-onlyrequired

mentor.mcp_servers[].platformintegerread-onlyrequired

mentor.mcp_servers[].namestring<= 255 charactersrequired

mentor.mcp_servers[].urlstring(uri)<= 200 charactersrequired

The url of the MCP server.

mentor.mcp_servers[].transportstring(TransportEnum)

sse - Sse
websocket - Websocket

Enum"sse""websocket"

mentor.mcp_servers[].headersany

Headers to send to the MCP server. Useful for authentication,

mentor.mcp_servers[].platform_keystringread-onlyrequired

mentor.mcp_servers[].created_atstring(date-time)read-onlyrequired

mentor.mcp_servers[].updated_atstring(date-time)read-onlyrequired

mentor.last_accessed_byinteger or null[ 0 .. 2147483647 ]

edX user ID

mentor.recently_accessed_atstring or null(date-time)

mentor.created_bystring or null<= 255 characters

mentor.created_atstring or null(date-time)read-onlyrequired

mentor.updated_atstring or null(date-time)read-onlyrequired

titlestring<= 255 charactersrequired

usernamestringread-onlyrequired

descriptionstring

promptstring

Prompt for the periodic agent if any.

taskobject(PeriodicTask)required

task.idintegerread-onlyrequired

task.namestringread-onlyrequired

Short Description For This Task

task.crontabobject(CrontabSchedule)required

task.crontab.minutestring(Minute(s))<= 240 characters

Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

task.crontab.hourstring(Hour(s))<= 96 characters

Cron Hours to Run. Use "*" for "all". (Example: "8,20")

task.crontab.day_of_weekstring(Day(s) Of The Week)<= 64 characters

Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")

task.crontab.day_of_monthstring(Day(s) Of The Month)<= 124 characters

Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

task.crontab.month_of_yearstring(Month(s) Of The Year)<= 64 characters

Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")

task.one_offboolean(One-off Task)

If True, the schedule will only run the task a single time

task.start_timestring or null(date-time)(Start Datetime)

Datetime when the schedule should begin triggering the task to run

task.enabledboolean

Set to False to disable the schedule

created_atstring(date-time)read-onlyrequired

modified_atstring(date-time)read-onlyrequired

enabledbooleanread-onlyrequired

one_offbooleanread-onlyrequired

platform_keystringread-onlyrequired

pathwaystring<= 255 characters

callback_urlstring(uri)<= 200 characters

callback_secretstring<= 255 characters

parent_session_idstring<= 200 characters

parent_mentor_idinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]

previous_agentinteger or null

Agent that needs to run before the current agent runs.

previous_agent_statusstring

success - Success
error - Error
running - Running
pending - Pending

Enum"success""error""running""pending"

previous_agent_outputstringread-onlyrequired

This will be fed into the run of this agent as part of its input prompt.

Response

application/json

{
  "id": 0,
  "mentor": {
    "name": "string",
    "unique_id": "677cf8c4-9b37-4a4b-b000-2ee947357c3a",
    "flow": null,
    "slug": "string",
    "platform": "string",
    "allow_anonymous": true,
    "metadata": null,
    "enable_moderation": true,
    "enable_post_processing_system": true,
    "enable_openai_assistant": true,
    "enable_total_grounding": true,
    "enable_suggested_prompts": true,
    "enable_guided_prompts": true,
    "guided_prompt_instructions": "string",
    "google_voice": 0,
    "openai_voice": 0,
    "categories": [ … ],
    "proactive_prompt": "string",
    "moderation_system_prompt": "string",
    "post_processing_prompt": "string",
    "moderation_response": "string",
    "safety_system_prompt": "string",
    "safety_response": "string",
    "enable_safety_system": true,
    "proactive_response": "string",
    "greeting_method": "proactive_prompt",
    "call_configuration": { … },
    "mcp_servers": [ … ],
    "last_accessed_by": 2147483647,
    "recently_accessed_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "title": "string",
  "username": "string",
  "description": "string",
  "prompt": "string",
  "task": {
    "id": 0,
    "name": "string",
    "crontab": { … },
    "one_off": true,
    "start_time": "2019-08-24T14:15:22Z",
    "enabled": true
  },
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "one_off": true,
  "platform_key": "string",
  "pathway": "string",
  "callback_url": "http://example.com",
  "callback_secret": "string",
  "parent_session_id": "string",
  "parent_mentor_id": -9223372036854776000,
  "previous_agent": 0,
  "previous_agent_status": "success",
  "previous_agent_output": "string"
}

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

search

Operations

skills

Operations

ibl-data-manager (3.59.0-ai-plus)

ai-account

ai-analytics

ai-bot

ai-finetuning

ai-index

ai-marketing

ai-media

ai-mentor

ai_mentor_orgs_users_periodic_agents_list

Request

Responses

Was this helpful?

ai_mentor_orgs_users_periodic_agents_create

Request

Responses

Was this helpful?

ai_mentor_orgs_users_periodic_agents_retrieve

Request

Responses

Was this helpful?

ai-prompt

career

catalog

core

credentials

features

media

notifications

scim

commerce

recommendations

reports

search

skills

ibl-data-manager (3.59.0-ai-plus)

ai-account

ai-analytics

ai-bot

ai-finetuning

ai-index

ai-marketing

ai-media

ai-mentor

ai_mentor_orgs_users_periodic_agents_list

Request

Responses

Was this helpful?

ai_mentor_orgs_users_periodic_agents_create

RequestExpand all

Responses

Was this helpful?

ai_mentor_orgs_users_periodic_agents_retrieve

Request

Responses

Was this helpful?

ai-prompt

career

catalog

core

credentials

features

media

notifications

scim

commerce

recommendations

reports

search

skills

Request