Interface InvocationClaims

What a verified token says; never the token itself. IDs are canonical lower-case UUIDs.

interface InvocationClaims {
    aud: string;
    billingMode: string;
    channelId: string;
    commandId: string | undefined;
    exp: number;
    iat: number;
    interactionId: string | undefined;
    iss: string;
    jti: string;
    level: string;
    messageId: string | undefined;
    permissionVersion: number;
    runId: string | undefined;
    spaceId: string;
    sub: string;
    threadId: string;
    toolClass: string;
    triggerKind: string;
}

Index

Properties

aud billingMode channelId commandId exp iat interactionId iss jti level messageId permissionVersion runId spaceId sub threadId toolClass triggerKind

Properties

`Readonly`aud

aud: string

The agent the token is for.

`Readonly`billingMode

billingMode: string

The configured billing mode.

`Readonly`channelId

channelId: string

The channel.

`Readonly`commandId

commandId: string | undefined

The triggering command, when it is one.

`Readonly`exp

exp: number

Expiry, seconds since the epoch.

`Readonly`iat

iat: number

Issued at, seconds since the epoch.

`Readonly`interactionId

interactionId: string | undefined

The triggering interaction, when it is one.

`Readonly`iss

iss: string

The issuing instance.

`Readonly`jti

jti: string

The token ID.

`Readonly`level

level: string

The effective level of sub on the channel.

`Readonly`messageId

messageId: string | undefined

The triggering message, when it is one.

`Readonly`permissionVersion

permissionVersion: number

The permission version at delivery time.

`Readonly`runId

runId: string | undefined

The run, when the token has one.

`Readonly`spaceId

spaceId: string

The space of the channel.

`Readonly`sub

sub: string

The triggering principal.

`Readonly`threadId

threadId: string

The thread.

`Readonly`toolClass

toolClass: string

The configured tool class.

`Readonly`triggerKind

triggerKind: string

message, followup, interaction, command or autocomplete.

Interface InvocationClaims

Index

Properties

Properties

`Readonly`aud

`Readonly`billingMode

`Readonly`channelId

`Readonly`commandId

`Readonly`exp

`Readonly`iat

`Readonly`interactionId

`Readonly`iss

`Readonly`jti

`Readonly`level

`Readonly`messageId

`Readonly`permissionVersion

`Readonly`runId

`Readonly`spaceId

`Readonly`sub

`Readonly`threadId

`Readonly`toolClass

`Readonly`triggerKind

Settings

On This Page

Interface InvocationClaims

Index

Properties

Properties

Readonlyaud

ReadonlybillingMode

ReadonlychannelId

ReadonlycommandId

Readonlyexp

Readonlyiat

ReadonlyinteractionId

Readonlyiss

Readonlyjti

Readonlylevel

ReadonlymessageId

ReadonlypermissionVersion

ReadonlyrunId

ReadonlyspaceId

Readonlysub

ReadonlythreadId

ReadonlytoolClass

ReadonlytriggerKind

Settings

On This Page

`Readonly`aud

`Readonly`billingMode

`Readonly`channelId

`Readonly`commandId

`Readonly`exp

`Readonly`iat

`Readonly`interactionId

`Readonly`iss

`Readonly`jti

`Readonly`level

`Readonly`messageId

`Readonly`permissionVersion

`Readonly`runId

`Readonly`spaceId

`Readonly`sub

`Readonly`threadId

`Readonly`toolClass

`Readonly`triggerKind