Namespace Reference

Iris

Curated JQL namespaces and examples for iris.

Iris namespaces cover topics, tenant AI token accounts, credit transactions, tenant Iris settings, user access, chat, tool lists, skills, capabilities, text transforms, and audio transcription.

Key namespaces and models

  • iris.Topic
  • iris.TenantAiTokenAccount
  • iris.TenantAiTokenTransaction
  • iris.TenantIrisSettings
  • iris.UserIrisAccess
  • subscriptions.IrisCreditPurchase

Common controller intents

  • iris.Iris.chat
  • iris.Iris.transformText
  • iris.Iris.listActions
  • iris.IrisV2.chat
  • iris.IrisV2.chatQueued
  • iris.IrisV2.listTopics
  • iris.IrisV2.transcribeAudio
  • iris.IrisV2.listTools
  • iris.IrisV2.listSkills
  • iris.IrisV2.capabilities
  • iris.IrisSettings.getTenantSettings
  • iris.IrisSettings.updateUserAccess
  • subscriptions.IrisCredits.listCreditPackages

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "iris.Topic", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "iris.Topic", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null, 11 "enabled": null 12 } 13 }, 14 "name": "Support agent", 15 "alias": "support-agent", 16 "enabled": true 17}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.

Chat example

json
1{ 2 "__meta__": { 3 "schema": "controller", 4 "namespace": "iris.IrisV2", 5 "intent": "chat", 6 "authenticationClass": "jwt" 7 }, 8 "message": "Summarise open support tickets", 9 "topic": "support-agent", 10 "context": { 11 "namespace": "tickets.Ticket" 12 } 13}