SDK: agent

The agent area has 9 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

agentApprovalDecide

Approve or deny an agent action

• Request: POST on /v1/tenants/{tenantId}/agent/approvals/{approvalId}/decide

agentApprovalDecide(args: { tenantId: string; approvalId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

agentApprovalGet

Read an agent approval card

• Request: GET on /v1/tenants/{tenantId}/agent/approvals/{approvalId}

agentApprovalGet(args: { tenantId: string; approvalId: string }, options?: CallOptions): Promise<AgentApprovalShow>

agentApprovalUndo

Undo an approved agent action

• Request: POST on /v1/tenants/{tenantId}/agent/approvals/{approvalId}/undo

agentApprovalUndo(args: { tenantId: string; approvalId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

agentAudit

The Overlane Agent’s audit trail

• Request: GET on /v1/tenants/{tenantId}/agent/audit

agentAudit(args: { tenantId: string }, options?: CallOptions): Promise<AgentAuditList>

agentChat

Send the Overlane Agent a message

• Request: POST on /v1/tenants/{tenantId}/agent/chat

agentChat(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

agentConfig

The Overlane Agent’s configuration for the team

• Request: GET on /v1/tenants/{tenantId}/agent/config

agentConfig(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

agentConversation

Read an agent conversation

• Request: GET on /v1/tenants/{tenantId}/agent/conversations/{conversationId}

agentConversation(args: { tenantId: string; conversationId: string }, options?: CallOptions): Promise<AgentConversation>

agentFeedback

Rate an agent answer

• Request: POST on /v1/tenants/{tenantId}/agent/feedback

agentFeedback(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

agentReadonly

Turn the Overlane Agent’s read-only mode on or off

• Request: PUT on /v1/tenants/{tenantId}/agent/readonly

agentReadonly(args: { tenantId: string; body: AgentReadOnlyRequest }, options?: CallOptions): Promise<AgentReadOnlyMode>