@plentymarkets/shop-api / DoInvokeCoreSupervisorParams
Interface: DoInvokeCoreSupervisorParams ​
Defined in: types/api/coreSupervisor.ts:10
Properties ​
advancedConsent? ​
optionaladvancedConsent?:boolean
Defined in: types/api/coreSupervisor.ts:26
Forwarded as the advanced-consent custom header. Defaults to true.
authToken ​
authToken:
string
Defined in: types/api/coreSupervisor.ts:20
plentymarkets auth token forwarded as a custom header for the agent's tools.
basicConsent? ​
optionalbasicConsent?:boolean
Defined in: types/api/coreSupervisor.ts:24
Forwarded as the basic-consent custom header. Defaults to true.
coreFunctionality? ​
optionalcoreFunctionality?:CoreFunctionality
Defined in: types/api/coreSupervisor.ts:22
Agent role. Defaults to 'core-supervisor'.
plentyId ​
plentyId:
number
Defined in: types/api/coreSupervisor.ts:16
Tenant id; forwarded as a custom header and used to build the client id.
prompt ​
prompt:
string
Defined in: types/api/coreSupervisor.ts:12
Prompt forwarded to the agent.
qualifier? ​
optionalqualifier?:string
Defined in: types/api/coreSupervisor.ts:31
Runtime qualifier override (e.g. 'development'). Defaults to api.coreSupervisor.qualifier or 'production'.
sessionId ​
sessionId:
string
Defined in: types/api/coreSupervisor.ts:14
Stable id reused for the runtime session (drives short-term memory).
user ​
user:
string
Defined in: types/api/coreSupervisor.ts:18
Human-readable user identifier; slugged into the user_id payload field.