Iblai api agent disclaimer

iblai-api-agent-disclaimer

Manage an agent's disclaimers via the API: the Advisory text (a single field on the agent's settings/) and the User Agreement (its own create / update / activate lifecycle). Use when adding legal or advisory notices users must see or accept.

Auth & conventions

• Base URL: https://api.iblai.app
• Header: Authorization: Api-Token $IBLAI_API_KEY on every request.
• Path vars: {org} = $IBLAI_ORG, {username} = $IBLAI_USERNAME, {mentor} = the agent's unique id (e.g. d17dc729-60fd-4363-81a0-f67d9318b03e).
• Not connected yet? Run /iblai-api-login first to populate IBLAI_ORG, IBLAI_USERNAME, and IBLAI_API_KEY.

Reads

• GET https://api.iblai.app/dm/api/ai-mentor/orgs/{org}/users/{username}/mentors/{mentor}/settings/ — Advisory text lives in the disclaimer field.
• GET https://api.iblai.app/dm/api/ai-mentor/orgs/{org}/users/{username}/disclaimers/?mentor_id={mentor}&scope=mentor — User Agreement list (read results[0] for the active agreement).

Writes

• PUT …/users/{username}/mentors/{mentor}/settings/ — save Advisory text:

  {
    "disclaimer": "string"
  }
  

• POST …/users/{username}/disclaimers/ — create a User Agreement:

  {
    "content": "string (required)",
    "mentors": ["uuid"],
    "scope": "mentor",
    "active": "boolean"
  }
  

• PATCH …/users/{username}/disclaimers/{id}/ — update content or toggle activation:

  {
    "content": "string"
  }
  

  or

  {
    "active": "boolean"
  }
  

Example

Create and activate a User Agreement for an agent:

curl -X POST \
  "https://api.iblai.app/dm/api/ai-mentor/orgs/$IBLAI_ORG/users/$IBLAI_USERNAME/disclaimers/" \
  -H "Authorization: Api-Token $IBLAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "By continuing, you agree to use this assistant for educational purposes only.",
    "mentors": ["'"$MENTOR"'"],
    "scope": "mentor",
    "active": true
  }'

Notes

• The Advisory is one field (disclaimer) on the agent settings/ — send only that key in the PUT; other settings are left unchanged.
• The User Agreement is a separate object users must accept; activate exactly one per agent via active: true, and deactivate others with a PATCH active: false.
• The disclaimers list endpoint is filtered with mentor_id + scope=mentor; the current agreement is the first item in results.