Skip to content

Interface: AppServiceData ​

Definition of an app service: a function exposed by an app, callable from other contexts (widget, AI bot, AI assistant…) with a description, typed arguments and a callback.

Properties ​

args ​

ts
args: AppServiceArgumentData[];

List of arguments expected by the service.


call ​

ts
call: AppServiceCallFunction;

Function executed when the service is called.


description ​

ts
description: string;

Human-facing description of the service.


description_for_ai? ​

ts
optional description_for_ai?: string;

AI-facing description of the service (model-oriented wording).


domains ​

ts
domains: AppServiceDomains[];

Contexts allowed to call the service (*, app, widget, aibot, aiassistant).


granted_role? ​

ts
optional granted_role?: AppServiceGrantedRole;

Minimum role for AI calls on behalf of a user; see AppServiceGrantedRole.


name ​

ts
name: string;

Unique name of the service (used as the identifier to call it).


type? ​

ts
optional type?: string;

Free-form category / type of the service (optional).