Class Agent

Agent is the authoritative agent data boundary. Read RPCs for sessions, turns, turn events, and interactions should use provider-owned control-plane state and should not require a live execution sandbox, pod-level transport, or cached tunnel.

Constructors

constructor

new Agent(
transport: Transport,
options?: { context?: RequestContext; timeoutMs?: number },
): Agent
Parameters
- transport: Transport
- Optionaloptions: { context?: RequestContext; timeoutMs?: number }
Returns Agent

Methods

`Static`connect

connect(
    options?: {
        name?: string;
        context?: RequestContext;
        timeoutMs?: number;
    },
): Agent
Parameters
- Optionaloptions: { name?: string; context?: RequestContext; timeoutMs?: number }
Returns Agent

createSession

createSession(
    idempotencyKey: string,
    model: string,
    options?: {
        providerName?: string;
        clientRef?: string;
        metadata?: object;
        workspace?: {
            checkouts?: { url?: string; ref?: string; path?: string }[];
            cwd?: string;
        };
        tools?: {
            source?: | { case: undefined; value?: undefined }
            | { case: "none"; value: {} }
            | {
                case: "catalog";
                value: {
                    refs?: {
                        app?: (...) | (...);
                        operation?: (...) | (...);
                        connection?: (...) | (...);
                        instance?: (...) | (...);
                        title?: (...) | (...);
                        description?: (...) | (...);
                        credentialMode?: (...) | (...);
                        system?: (...) | (...);
                        runAs?: (...) | (...);
                    }[];
                    tools?: {
                        id?: (...)
                        | (...);
                        mcpName?: (...) | (...);
                        title?: (...) | (...);
                        description?: (...) | (...);
                        inputSchema?: (...) | (...);
                        outputSchema?: (...) | (...);
                        annotations?: (...) | (...);
                        ref?: (...) | (...);
                        tags?: (...) | (...);
                        searchText?: (...) | (...);
                    }[];
                };
            };
        };
    },
): Promise<AgentSession>
Parameters
- idempotencyKey: string
- model: string
- Optionaloptions: {
      providerName?: string;
      clientRef?: string;
      metadata?: object;
      workspace?: {
          checkouts?: { url?: string; ref?: string; path?: string }[];
          cwd?: string;
      };
      tools?: {
          source?: | { case: undefined; value?: undefined }
          | { case: "none"; value: {} }
          | {
              case: "catalog";
              value: {
                  refs?: {
                      app?: (...) | (...);
                      operation?: (...) | (...);
                      connection?: (...) | (...);
                      instance?: (...) | (...);
                      title?: (...) | (...);
                      description?: (...) | (...);
                      credentialMode?: (...) | (...);
                      system?: (...) | (...);
                      runAs?: (...) | (...);
                  }[];
                  tools?: {
                      id?: (...)
                      | (...);
                      mcpName?: (...) | (...);
                      title?: (...) | (...);
                      description?: (...) | (...);
                      inputSchema?: (...) | (...);
                      outputSchema?: (...) | (...);
                      annotations?: (...) | (...);
                      ref?: (...) | (...);
                      tags?: (...) | (...);
                      searchText?: (...) | (...);
                  }[];
              };
          };
      };
  }
Returns Promise<AgentSession>

createSessionRaw

createSessionRaw(
    request: {
        idempotencyKey?: string;
        model?: string;
        clientRef?: string;
        metadata?: object;
        sessionStart?: {
            hooks?: {
                id?: string;
                type?: string;
                command?: string[];
                cwd?: string;
                timeout?: string;
                env?: { [key: string]: string };
                output?: { additionalContext?: boolean; metadata?: boolean };
            }[];
        };
        preparedWorkspace?: { root?: string; cwd?: string };
        providerName?: string;
        workspace?: {
            checkouts?: { url?: string; ref?: string; path?: string }[];
            cwd?: string;
        };
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        tools?: {
            source?: | { case: undefined; value?: undefined }
            | { case: "none"; value: {} }
            | {
                case: "catalog";
                value: {
                    refs?: {
                        app?: string;
                        operation?: string;
                        connection?: string;
                        instance?: string;
                        title?: string;
                        description?: string;
                        credentialMode?: string;
                        system?: string;
                        runAs?: {
                            id?: ...;
                            email?: ...;
                            displayName?: ...;
                            scopes?: ...;
                            permissions?: ...;
                        };
                    }[];
                    tools?: {
                        id?: string;
                        mcpName?: string;
                        title?: string;
                        description?: string;
                        inputSchema?: string;
                        outputSchema?: string;
                        annotations?: {
                            readOnlyHint?: ...;
                            idempotentHint?: ...;
                            destructiveHint?: ...;
                            openWorldHint?: ...;
                        };
                        ref?: {
                            app?: ...;
                            operation?: ...;
                            connection?: ...;
                            instance?: ...;
                            title?: ...;
                            description?: ...;
                            credentialMode?: ...;
                            system?: ...;
                            runAs?: ...;
                        };
                        tags?: (...)[];
                        searchText?: string;
                    }[];
                };
            };
        };
    },
): Promise<AgentSession>
Parameters
- request: {
      idempotencyKey?: string;
      model?: string;
      clientRef?: string;
      metadata?: object;
      sessionStart?: {
          hooks?: {
              id?: string;
              type?: string;
              command?: string[];
              cwd?: string;
              timeout?: string;
              env?: { [key: string]: string };
              output?: { additionalContext?: boolean; metadata?: boolean };
          }[];
      };
      preparedWorkspace?: { root?: string; cwd?: string };
      providerName?: string;
      workspace?: {
          checkouts?: { url?: string; ref?: string; path?: string }[];
          cwd?: string;
      };
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      tools?: {
          source?: | { case: undefined; value?: undefined }
          | { case: "none"; value: {} }
          | {
              case: "catalog";
              value: {
                  refs?: {
                      app?: string;
                      operation?: string;
                      connection?: string;
                      instance?: string;
                      title?: string;
                      description?: string;
                      credentialMode?: string;
                      system?: string;
                      runAs?: {
                          id?: ...;
                          email?: ...;
                          displayName?: ...;
                          scopes?: ...;
                          permissions?: ...;
                      };
                  }[];
                  tools?: {
                      id?: string;
                      mcpName?: string;
                      title?: string;
                      description?: string;
                      inputSchema?: string;
                      outputSchema?: string;
                      annotations?: {
                          readOnlyHint?: ...;
                          idempotentHint?: ...;
                          destructiveHint?: ...;
                          openWorldHint?: ...;
                      };
                      ref?: {
                          app?: ...;
                          operation?: ...;
                          connection?: ...;
                          instance?: ...;
                          title?: ...;
                          description?: ...;
                          credentialMode?: ...;
                          system?: ...;
                          runAs?: ...;
                      };
                      tags?: (...)[];
                      searchText?: string;
                  }[];
              };
          };
      };
  }
  - OptionalidempotencyKey?: string
    The provider mints the session id returned on AgentSession. Creation is idempotent on idempotency_key scoped per caller (context.subject.id): a replayed key returns the existing session, an empty key always creates. Idempotency is scoped to the provider's session store.
  - Optionalmodel?: string
  - OptionalclientRef?: string
  - Optionalmetadata?: object
  - OptionalsessionStart?: {
        hooks?: {
            id?: string;
            type?: string;
            command?: string[];
            cwd?: string;
            timeout?: string;
            env?: { [key: string]: string };
            output?: { additionalContext?: boolean; metadata?: boolean };
        }[];
    }
  - OptionalpreparedWorkspace?: { root?: string; cwd?: string }
  - OptionalproviderName?: string
  - Optionalworkspace?: { checkouts?: { url?: string; ref?: string; path?: string }[]; cwd?: string }
  - Optionalcontext?: {
        subject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        credential?: {
            mode?: string;
            subjectId?: string;
            connection?: string;
            instance?: string;
        };
        access?: { policy?: string; role?: string };
        workflow?: object;
        host?: { publicBaseUrl?: string };
        agentSubject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        caller?: { kind?: string; name?: string };
        invocation?: {
            requestId?: string;
            depth?: number;
            callChain?: string[];
            surface?: string;
            internalConnectionAccess?: boolean;
            connection?: string;
        };
        toolRefs?: {
            app?: string;
            operation?: string;
            connection?: string;
            instance?: string;
            title?: string;
            description?: string;
            credentialMode?: string;
            system?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
            };
        }[];
        toolRefsSet?: boolean;
        requestMeta?: {
            clientIp?: string;
            remoteAddr?: string;
            userAgent?: string;
        };
        agent?: { providerName?: string; sessionId?: string; turnId?: string };
    }
    Optionalsubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
    Optionalaccess?: { policy?: string; role?: string }
    Optionalworkflow?: object
    Optionalhost?: { publicBaseUrl?: string }
    OptionalagentSubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Original agent caller when an agent tool executes with delegated run-as identity.
    
    Optionalcaller?: { kind?: string; name?: string }
    Optionalinvocation?: {
        requestId?: string;
        depth?: number;
        callChain?: string[];
        surface?: string;
        internalConnectionAccess?: boolean;
        connection?: string;
    }
    OptionaltoolRefs?: {
        app?: string;
        operation?: string;
        connection?: string;
        instance?: string;
        title?: string;
        description?: string;
        credentialMode?: string;
        system?: string;
        runAs?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
        };
    }[]
    Agent tool refs granted to the operation request, when the request is executing as an agent tool.
    
    OptionaltoolRefsSet?: boolean
    Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.
    
    OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
    Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
  - Optionaltools?: {
        source?:
            | { case: undefined; value?: undefined }
            | { case: "none"; value: {} }
            | {
                case: "catalog";
                value: {
                    refs?: {
                        app?: string;
                        operation?: string;
                        connection?: string;
                        instance?: string;
                        title?: string;
                        description?: string;
                        credentialMode?: string;
                        system?: string;
                        runAs?: {
                            id?: ...;
                            email?: ...;
                            displayName?: ...;
                            scopes?: ...;
                            permissions?: ...;
                        };
                    }[];
                    tools?: {
                        id?: string;
                        mcpName?: string;
                        title?: string;
                        description?: string;
                        inputSchema?: string;
                        outputSchema?: string;
                        annotations?: {
                            readOnlyHint?: ...;
                            idempotentHint?: ...;
                            destructiveHint?: ...;
                            openWorldHint?: ...;
                        };
                        ref?: {
                            app?: ...;
                            operation?: ...;
                            connection?: ...;
                            instance?: ...;
                            title?: ...;
                            description?: ...;
                            credentialMode?: ...;
                            system?: ...;
                            runAs?: ...;
                        };
                        tags?: (...)[];
                        searchText?: string;
                    }[];
                };
            };
    }
Returns Promise<AgentSession>

getSession

getSession(
sessionId: string,
options?: { providerName?: string },
): Promise<AgentSession>
Parameters
- sessionId: string
- Optionaloptions: { providerName?: string }
Returns Promise<AgentSession>

getSessionRaw

getSessionRaw(
    request: {
        sessionId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<AgentSession>
Parameters
- request: {
      sessionId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
Returns Promise<AgentSession>

listSessions

listSessions(
    options?: {
        sessionIds?: string[];
        state?: number;
        limit?: number;
        summaryOnly?: boolean;
        providerName?: string;
    },
): Promise<AgentSession[]>
Parameters
- Optionaloptions: {
      sessionIds?: string[];
      state?: number;
      limit?: number;
      summaryOnly?: boolean;
      providerName?: string;
  }
Returns Promise<AgentSession[]>

listSessionsRaw

listSessionsRaw(
    request: {
        sessionIds?: string[];
        state?: number;
        limit?: number;
        summaryOnly?: boolean;
        providerName?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<ListAgentProviderSessionsResponse>
Parameters
- request: {
      sessionIds?: string[];
      state?: number;
      limit?: number;
      summaryOnly?: boolean;
      providerName?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
  - OptionalsessionIds?: string[]
  - Optionalstate?: number
  - Optionallimit?: number
    When non-zero and bounded_list_hydration is supported, cap results after ordering sessions newest-first by last_turn_at, updated_at, then created_at.
  - OptionalsummaryOnly?: boolean
    When true and bounded_list_hydration is supported, omit heavy fields such as metadata unless exact session_ids require direct lookup.
  - OptionalproviderName?: string
  - Optionalcontext?: {
        subject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        credential?: {
            mode?: string;
            subjectId?: string;
            connection?: string;
            instance?: string;
        };
        access?: { policy?: string; role?: string };
        workflow?: object;
        host?: { publicBaseUrl?: string };
        agentSubject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        caller?: { kind?: string; name?: string };
        invocation?: {
            requestId?: string;
            depth?: number;
            callChain?: string[];
            surface?: string;
            internalConnectionAccess?: boolean;
            connection?: string;
        };
        toolRefs?: {
            app?: string;
            operation?: string;
            connection?: string;
            instance?: string;
            title?: string;
            description?: string;
            credentialMode?: string;
            system?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
            };
        }[];
        toolRefsSet?: boolean;
        requestMeta?: {
            clientIp?: string;
            remoteAddr?: string;
            userAgent?: string;
        };
        agent?: { providerName?: string; sessionId?: string; turnId?: string };
    }
    Optionalsubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
    Optionalaccess?: { policy?: string; role?: string }
    Optionalworkflow?: object
    Optionalhost?: { publicBaseUrl?: string }
    OptionalagentSubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Original agent caller when an agent tool executes with delegated run-as identity.
    
    Optionalcaller?: { kind?: string; name?: string }
    Optionalinvocation?: {
        requestId?: string;
        depth?: number;
        callChain?: string[];
        surface?: string;
        internalConnectionAccess?: boolean;
        connection?: string;
    }
    OptionaltoolRefs?: {
        app?: string;
        operation?: string;
        connection?: string;
        instance?: string;
        title?: string;
        description?: string;
        credentialMode?: string;
        system?: string;
        runAs?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
        };
    }[]
    Agent tool refs granted to the operation request, when the request is executing as an agent tool.
    
    OptionaltoolRefsSet?: boolean
    Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.
    
    OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
    Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
Returns Promise<ListAgentProviderSessionsResponse>

updateSession

updateSession(
    sessionId: string,
    options?: {
        clientRef?: string;
        state?: number;
        providerName?: string;
        metadata?: object;
    },
): Promise<AgentSession>
Parameters
- sessionId: string
- Optionaloptions: { clientRef?: string; state?: number; providerName?: string; metadata?: object }
Returns Promise<AgentSession>

updateSessionRaw

updateSessionRaw(
    request: {
        sessionId?: string;
        clientRef?: string;
        state?: number;
        metadata?: object;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<AgentSession>
Parameters
- request: {
      sessionId?: string;
      clientRef?: string;
      state?: number;
      metadata?: object;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
Returns Promise<AgentSession>

createTurn

createTurn(
    sessionId: string,
    idempotencyKey: string,
    model: string,
    messages: {
        role?: string;
        text?: string;
        parts?: {
            type?: number;
            text?: string;
            json?: object;
            toolCall?: { id?: string; toolId?: string; arguments?: object };
            toolResult?: {
                toolCallId?: string;
                status?: number;
                content?: string;
                output?: object;
            };
            imageRef?: { uri?: string; mimeType?: string };
        }[];
        metadata?: object;
    }[],
    options?: {
        executionRef?: string;
        timeoutSeconds?: number;
        providerName?: string;
        metadata?: object;
        modelOptions?: object;
        output?: {
            kind?:
                | { case: undefined; value?: undefined }
                | { case: "text"; value: {} }
                | { case: "structured"; value: { schema?: object } };
        };
    },
): Promise<AgentTurn>
Parameters
- sessionId: string
- idempotencyKey: string
- model: string
- messages: {
      role?: string;
      text?: string;
      parts?: {
          type?: number;
          text?: string;
          json?: object;
          toolCall?: { id?: string; toolId?: string; arguments?: object };
          toolResult?: {
              toolCallId?: string;
              status?: number;
              content?: string;
              output?: object;
          };
          imageRef?: { uri?: string; mimeType?: string };
      }[];
      metadata?: object;
  }[]
- Optionaloptions: {
      executionRef?: string;
      timeoutSeconds?: number;
      providerName?: string;
      metadata?: object;
      modelOptions?: object;
      output?: {
          kind?:
              | { case: undefined; value?: undefined }
              | { case: "text"; value: {} }
              | { case: "structured"; value: { schema?: object } };
      };
  }
Returns Promise<AgentTurn>

createTurnRaw

createTurnRaw(
    request: {
        turnId?: string;
        sessionId?: string;
        idempotencyKey?: string;
        model?: string;
        messages?: {
            role?: string;
            text?: string;
            parts?: {
                type?: number;
                text?: string;
                json?: object;
                toolCall?: { id?: string; toolId?: string; arguments?: object };
                toolResult?: {
                    toolCallId?: string;
                    status?: number;
                    content?: string;
                    output?: object;
                };
                imageRef?: { uri?: string; mimeType?: string };
            }[];
            metadata?: object;
        }[];
        metadata?: object;
        executionRef?: string;
        modelOptions?: object;
        timeoutSeconds?: number;
        output?: {
            kind?: | { case: undefined; value?: undefined }
            | { case: "text"; value: {} }
            | { case: "structured"; value: { schema?: object } };
        };
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<AgentTurn>
Parameters
- request: {
      turnId?: string;
      sessionId?: string;
      idempotencyKey?: string;
      model?: string;
      messages?: {
          role?: string;
          text?: string;
          parts?: {
              type?: number;
              text?: string;
              json?: object;
              toolCall?: { id?: string; toolId?: string; arguments?: object };
              toolResult?: {
                  toolCallId?: string;
                  status?: number;
                  content?: string;
                  output?: object;
              };
              imageRef?: { uri?: string; mimeType?: string };
          }[];
          metadata?: object;
      }[];
      metadata?: object;
      executionRef?: string;
      modelOptions?: object;
      timeoutSeconds?: number;
      output?: {
          kind?: | { case: undefined; value?: undefined }
          | { case: "text"; value: {} }
          | { case: "structured"; value: { schema?: object } };
      };
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
  - OptionalturnId?: string
  - OptionalsessionId?: string
  - OptionalidempotencyKey?: string
  - Optionalmodel?: string
  - Optionalmessages?: {
        role?: string;
        text?: string;
        parts?: {
            type?: number;
            text?: string;
            json?: object;
            toolCall?: { id?: string; toolId?: string; arguments?: object };
            toolResult?: {
                toolCallId?: string;
                status?: number;
                content?: string;
                output?: object;
            };
            imageRef?: { uri?: string; mimeType?: string };
        }[];
        metadata?: object;
    }[]
  - Optionalmetadata?: object
  - OptionalexecutionRef?: string
  - OptionalmodelOptions?: object
  - OptionaltimeoutSeconds?: number
    Optional provider-owned turn execution budget, in seconds. If unset or zero, the provider chooses its own execution timeout. This does not control the CreateTurn RPC deadline.
  - Optionaloutput?: {
        kind?:
            | { case: undefined; value?: undefined }
            | { case: "text"; value: {} }
            | { case: "structured"; value: { schema?: object } };
    }
  - Optionalcontext?: {
        subject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        credential?: {
            mode?: string;
            subjectId?: string;
            connection?: string;
            instance?: string;
        };
        access?: { policy?: string; role?: string };
        workflow?: object;
        host?: { publicBaseUrl?: string };
        agentSubject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        caller?: { kind?: string; name?: string };
        invocation?: {
            requestId?: string;
            depth?: number;
            callChain?: string[];
            surface?: string;
            internalConnectionAccess?: boolean;
            connection?: string;
        };
        toolRefs?: {
            app?: string;
            operation?: string;
            connection?: string;
            instance?: string;
            title?: string;
            description?: string;
            credentialMode?: string;
            system?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
            };
        }[];
        toolRefsSet?: boolean;
        requestMeta?: {
            clientIp?: string;
            remoteAddr?: string;
            userAgent?: string;
        };
        agent?: { providerName?: string; sessionId?: string; turnId?: string };
    }
    Optionalsubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
    Optionalaccess?: { policy?: string; role?: string }
    Optionalworkflow?: object
    Optionalhost?: { publicBaseUrl?: string }
    OptionalagentSubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Original agent caller when an agent tool executes with delegated run-as identity.
    
    Optionalcaller?: { kind?: string; name?: string }
    Optionalinvocation?: {
        requestId?: string;
        depth?: number;
        callChain?: string[];
        surface?: string;
        internalConnectionAccess?: boolean;
        connection?: string;
    }
    OptionaltoolRefs?: {
        app?: string;
        operation?: string;
        connection?: string;
        instance?: string;
        title?: string;
        description?: string;
        credentialMode?: string;
        system?: string;
        runAs?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
        };
    }[]
    Agent tool refs granted to the operation request, when the request is executing as an agent tool.
    
    OptionaltoolRefsSet?: boolean
    Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.
    
    OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
    Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
  - OptionalproviderName?: string
Returns Promise<AgentTurn>

getTurn

getTurn(turnId: string, options?: { providerName?: string }): Promise<AgentTurn>
Parameters
- turnId: string
- Optionaloptions: { providerName?: string }
Returns Promise<AgentTurn>

getTurnRaw

getTurnRaw(
    request: {
        turnId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
        sessionId?: string;
    },
): Promise<AgentTurn>
Parameters
- request: {
      turnId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
      sessionId?: string;
  }
Returns Promise<AgentTurn>

listTurns

listTurns(
    sessionId: string,
    options?: {
        turnIds?: string[];
        status?: number;
        limit?: number;
        summaryOnly?: boolean;
        providerName?: string;
    },
): Promise<AgentTurn[]>
Parameters
- sessionId: string
- Optionaloptions: {
      turnIds?: string[];
      status?: number;
      limit?: number;
      summaryOnly?: boolean;
      providerName?: string;
  }
Returns Promise<AgentTurn[]>

listTurnsRaw

listTurnsRaw(
    request: {
        sessionId?: string;
        turnIds?: string[];
        status?: number;
        limit?: number;
        summaryOnly?: boolean;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<ListAgentProviderTurnsResponse>
Parameters
- request: {
      sessionId?: string;
      turnIds?: string[];
      status?: number;
      limit?: number;
      summaryOnly?: boolean;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
  - OptionalsessionId?: string
  - OptionalturnIds?: string[]
  - Optionalstatus?: number
  - Optionallimit?: number
    When non-zero and bounded_list_hydration is supported, cap results after ordering turns newest-first by created_at.
  - OptionalsummaryOnly?: boolean
    When true and bounded_list_hydration is supported, omit heavy fields such as messages, output text, and structured output unless exact turn_ids require direct lookup.
  - Optionalcontext?: {
        subject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        credential?: {
            mode?: string;
            subjectId?: string;
            connection?: string;
            instance?: string;
        };
        access?: { policy?: string; role?: string };
        workflow?: object;
        host?: { publicBaseUrl?: string };
        agentSubject?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        };
        caller?: { kind?: string; name?: string };
        invocation?: {
            requestId?: string;
            depth?: number;
            callChain?: string[];
            surface?: string;
            internalConnectionAccess?: boolean;
            connection?: string;
        };
        toolRefs?: {
            app?: string;
            operation?: string;
            connection?: string;
            instance?: string;
            title?: string;
            description?: string;
            credentialMode?: string;
            system?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
            };
        }[];
        toolRefsSet?: boolean;
        requestMeta?: {
            clientIp?: string;
            remoteAddr?: string;
            userAgent?: string;
        };
        agent?: { providerName?: string; sessionId?: string; turnId?: string };
    }
    Optionalsubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
    Optionalaccess?: { policy?: string; role?: string }
    Optionalworkflow?: object
    Optionalhost?: { publicBaseUrl?: string }
    OptionalagentSubject?: {
        id?: string;
        email?: string;
        displayName?: string;
        scopes?: string[];
        permissions?: {
            app?: string;
            operations?: string[];
            allOperations?: boolean;
        }[];
    }
    Original agent caller when an agent tool executes with delegated run-as identity.
    
    Optionalcaller?: { kind?: string; name?: string }
    Optionalinvocation?: {
        requestId?: string;
        depth?: number;
        callChain?: string[];
        surface?: string;
        internalConnectionAccess?: boolean;
        connection?: string;
    }
    OptionaltoolRefs?: {
        app?: string;
        operation?: string;
        connection?: string;
        instance?: string;
        title?: string;
        description?: string;
        credentialMode?: string;
        system?: string;
        runAs?: {
            id?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
        };
    }[]
    Agent tool refs granted to the operation request, when the request is executing as an agent tool.
    
    OptionaltoolRefsSet?: boolean
    Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.
    
    OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
    Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
  - OptionalproviderName?: string
Returns Promise<ListAgentProviderTurnsResponse>

cancelTurn

cancelTurn(
turnId: string,
options?: { reason?: string; providerName?: string },
): Promise<AgentTurn>
Parameters
- turnId: string
- Optionaloptions: { reason?: string; providerName?: string }
Returns Promise<AgentTurn>

cancelTurnRaw

cancelTurnRaw(
    request: {
        turnId?: string;
        reason?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
        sessionId?: string;
    },
): Promise<AgentTurn>
Parameters
- request: {
      turnId?: string;
      reason?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
      sessionId?: string;
  }
Returns Promise<AgentTurn>

listTurnEvents

listTurnEvents(
turnId: string,
options?: { afterSeq?: bigint; limit?: number; providerName?: string },
): Promise<AgentTurnEvent[]>
Parameters
- turnId: string
- Optionaloptions: { afterSeq?: bigint; limit?: number; providerName?: string }
Returns Promise<AgentTurnEvent[]>

listTurnEventsRaw

listTurnEventsRaw(
    request: {
        turnId?: string;
        afterSeq?: bigint;
        limit?: number;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
        sessionId?: string;
    },
): Promise<ListAgentProviderTurnEventsResponse>
Parameters
- request: {
      turnId?: string;
      afterSeq?: bigint;
      limit?: number;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
      sessionId?: string;
  }
Returns Promise<ListAgentProviderTurnEventsResponse>

getInteraction

getInteraction(interactionId: string): Promise<AgentInteraction>
Parameters
- interactionId: string
Returns Promise<AgentInteraction>

getInteractionRaw

getInteractionRaw(
    request: {
        interactionId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<AgentInteraction>
Parameters
- request: {
      interactionId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
Returns Promise<AgentInteraction>

listInteractions

listInteractions(
turnId: string,
options?: { providerName?: string },
): Promise<AgentInteraction[]>
Parameters
- turnId: string
- Optionaloptions: { providerName?: string }
Returns Promise<AgentInteraction[]>

listInteractionsRaw

listInteractionsRaw(
    request: {
        turnId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<ListAgentProviderInteractionsResponse>
Parameters
- request: {
      turnId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
Returns Promise<ListAgentProviderInteractionsResponse>

resolveInteraction

resolveInteraction(
    interactionId: string,
    turnId: string,
    resolution?: object,
    options?: { providerName?: string },
): Promise<AgentInteraction>
Parameters
- interactionId: string
- turnId: string
- Optionalresolution: object
- Optionaloptions: { providerName?: string }
Returns Promise<AgentInteraction>

resolveInteractionRaw

resolveInteractionRaw(
    request: {
        interactionId?: string;
        resolution?: object;
        turnId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        providerName?: string;
    },
): Promise<AgentInteraction>
Parameters
- request: {
      interactionId?: string;
      resolution?: object;
      turnId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      providerName?: string;
  }
Returns Promise<AgentInteraction>

getCapabilities

getCapabilities(request: {}): Promise<AgentProviderCapabilities>
Parameters
- request: {}
Returns Promise<AgentProviderCapabilities>

Class Agent

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Agent

Methods

Staticconnect

Parameters

Returns Agent

createSession

Parameters

Returns Promise<AgentSession>

createSessionRaw

Parameters

OptionalidempotencyKey?: string

Optionalmodel?: string

OptionalclientRef?: string

Optionalmetadata?: object

OptionalsessionStart?: { hooks?: { id?: string; type?: string; command?: string[]; cwd?: string; timeout?: string; env?: { [key: string]: string }; output?: { additionalContext?: boolean; metadata?: boolean }; }[];}

OptionalpreparedWorkspace?: { root?: string; cwd?: string }

OptionalproviderName?: string

Optionalworkspace?: { checkouts?: { url?: string; ref?: string; path?: string }[]; cwd?: string }

Optionalsubject?: { id?: string; email?: string; displayName?: string; scopes?: string[]; permissions?: { app?: string; operations?: string[]; allOperations?: boolean; }[];}

Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

Optionalaccess?: { policy?: string; role?: string }

Optionalworkflow?: object

Optionalhost?: { publicBaseUrl?: string }

OptionalagentSubject?: { id?: string; email?: string; displayName?: string; scopes?: string[]; permissions?: { app?: string; operations?: string[]; allOperations?: boolean; }[];}

Optionalcaller?: { kind?: string; name?: string }

Optionalinvocation?: { requestId?: string; depth?: number; callChain?: string[]; surface?: string; internalConnectionAccess?: boolean; connection?: string;}

OptionaltoolRefsSet?: boolean

OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }

Returns Promise<AgentSession>

getSession

Parameters

Returns Promise<AgentSession>

getSessionRaw

Parameters

Returns Promise<AgentSession>

listSessions

Parameters

Returns Promise<AgentSession[]>

listSessionsRaw

Parameters

OptionalsessionIds?: string[]

Optionalstate?: number

Optionallimit?: number

OptionalsummaryOnly?: boolean

OptionalproviderName?: string

Optionalsubject?: { id?: string; email?: string; displayName?: string; scopes?: string[]; permissions?: { app?: string; operations?: string[]; allOperations?: boolean; }[];}

Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

Optionalaccess?: { policy?: string; role?: string }

Optionalworkflow?: object

Optionalhost?: { publicBaseUrl?: string }

OptionalagentSubject?: { id?: string; email?: string; displayName?: string; scopes?: string[]; permissions?: { app?: string; operations?: string[]; allOperations?: boolean; }[];}

Optionalcaller?: { kind?: string; name?: string }

Optionalinvocation?: { requestId?: string; depth?: number; callChain?: string[]; surface?: string; internalConnectionAccess?: boolean; connection?: string;}

OptionaltoolRefsSet?: boolean

OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }

Returns Promise<ListAgentProviderSessionsResponse>

updateSession

Parameters

Returns Promise<AgentSession>

updateSessionRaw

Parameters

Returns Promise<AgentSession>

createTurn

Parameters

Returns Promise<AgentTurn>

createTurnRaw

Parameters

OptionalturnId?: string

OptionalsessionId?: string

OptionalidempotencyKey?: string

Optionalmodel?: string

`Static`connect

`Optional`idempotencyKey?: string

`Optional`model?: string

`Optional`clientRef?: string

`Optional`metadata?: object

`Optional`sessionStart?: {
hooks?: {
id?: string;
type?: string;
command?: string[];
cwd?: string;
timeout?: string;
env?: { [key: string]: string };
output?: { additionalContext?: boolean; metadata?: boolean };
}[];
}

`Optional`preparedWorkspace?: { root?: string; cwd?: string }

`Optional`providerName?: string

`Optional`workspace?: { checkouts?: { url?: string; ref?: string; path?: string }[]; cwd?: string }

`Optional`subject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`credential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

`Optional`access?: { policy?: string; role?: string }

`Optional`workflow?: object

`Optional`host?: { publicBaseUrl?: string }

`Optional`agentSubject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`caller?: { kind?: string; name?: string }

`Optional`invocation?: {
requestId?: string;
depth?: number;
callChain?: string[];
surface?: string;
internalConnectionAccess?: boolean;
connection?: string;
}

`Optional`toolRefsSet?: boolean

`Optional`requestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

`Optional`agent?: { providerName?: string; sessionId?: string; turnId?: string }

`Optional`sessionIds?: string[]

`Optional`state?: number

`Optional`limit?: number

`Optional`summaryOnly?: boolean

`Optional`providerName?: string

`Optional`subject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`credential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

`Optional`access?: { policy?: string; role?: string }

`Optional`workflow?: object

`Optional`host?: { publicBaseUrl?: string }

`Optional`agentSubject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`caller?: { kind?: string; name?: string }

`Optional`invocation?: {
requestId?: string;
depth?: number;
callChain?: string[];
surface?: string;
internalConnectionAccess?: boolean;
connection?: string;
}

`Optional`toolRefsSet?: boolean

`Optional`requestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

`Optional`agent?: { providerName?: string; sessionId?: string; turnId?: string }

`Optional`turnId?: string

`Optional`sessionId?: string

`Optional`idempotencyKey?: string

`Optional`model?: string

`Optional`metadata?: object

`Optional`executionRef?: string

`Optional`modelOptions?: object

`Optional`timeoutSeconds?: number

`Optional`output?: {
kind?:
| { case: undefined; value?: undefined }
| { case: "text"; value: {} }
| { case: "structured"; value: { schema?: object } };
}

`Optional`subject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`credential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

`Optional`access?: { policy?: string; role?: string }

`Optional`workflow?: object

`Optional`host?: { publicBaseUrl?: string }

`Optional`agentSubject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`caller?: { kind?: string; name?: string }

`Optional`invocation?: {
requestId?: string;
depth?: number;
callChain?: string[];
surface?: string;
internalConnectionAccess?: boolean;
connection?: string;
}

`Optional`toolRefsSet?: boolean

`Optional`requestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

`Optional`agent?: { providerName?: string; sessionId?: string; turnId?: string }

`Optional`providerName?: string

`Optional`sessionId?: string

`Optional`turnIds?: string[]

`Optional`status?: number

`Optional`limit?: number

`Optional`summaryOnly?: boolean

`Optional`subject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`credential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }

`Optional`access?: { policy?: string; role?: string }

`Optional`workflow?: object

`Optional`host?: { publicBaseUrl?: string }

`Optional`agentSubject?: {
id?: string;
email?: string;
displayName?: string;
scopes?: string[];
permissions?: {
app?: string;
operations?: string[];
allOperations?: boolean;
}[];
}

`Optional`caller?: { kind?: string; name?: string }

`Optional`invocation?: {
requestId?: string;
depth?: number;
callChain?: string[];
surface?: string;
internalConnectionAccess?: boolean;
connection?: string;
}

`Optional`toolRefsSet?: boolean

`Optional`requestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }

`Optional`agent?: { providerName?: string; sessionId?: string; turnId?: string }

`Optional`providerName?: string