Interface SkipCallOptions

Options for making a Skip API call

interface SkipCallOptions {
    contextUser: UserInfo;
    conversationId: string;
    dataContext?: DataContext;
    dataSource: ConnectionPool;
    forceEntityRefresh?: boolean;
    includeCallbackAuth?: boolean;
    includeEntities?: boolean;
    includeNotes?: boolean;
    includeQueries?: boolean;
    includeRequests?: boolean;
    messages: SkipMessage[];
    onStatusUpdate?: ((message, responsePhase?) => void);
    payload?: Record<string, any>;
    requestPhase?: SkipRequestPhase;
}

Properties

contextUser conversationId dataContext? dataSource forceEntityRefresh? includeCallbackAuth? includeEntities? includeNotes? includeQueries? includeRequests? messages onStatusUpdate? payload? requestPhase?

Properties

contextUser

contextUser: UserInfo

Context user for permissions and metadata

conversationId

conversationId: string

Conversation ID for tracking

Optional dataContext

dataContext?: DataContext

Data context to provide to Skip

dataSource

dataSource: ConnectionPool

Database connection for metadata queries

Optional forceEntityRefresh

forceEntityRefresh?: boolean

Force refresh of entity metadata cache

Optional includeCallbackAuth

includeCallbackAuth?: boolean

Include callback API key and access token for Skip to call back to MJ

Optional includeEntities

includeEntities?: boolean

Include entity metadata in request

Optional includeNotes

includeNotes?: boolean

Include agent notes in request

Optional includeQueries

includeQueries?: boolean

Include saved queries in request

Optional includeRequests

includeRequests?: boolean

Include agent requests in request

messages

messages: SkipMessage[]

Conversation messages (user/assistant)

Optional onStatusUpdate

onStatusUpdate?: ((message, responsePhase?) => void)

Callback for streaming status updates during execution

Type declaration

    • (message, responsePhase?): void

    • Parameters

      • message: string
      • Optional responsePhase: string

      Returns void

Optional payload

payload?: Record<string, any>

Optional payload data from a previous response (e.g., PRD in progress). This enables incremental artifact building where structured data accumulates throughout the conversation. When Skip returns a response with a payload, the client should pass that payload back in the next request.

Optional requestPhase

requestPhase?: SkipRequestPhase

Request phase (initial_request, clarify_question_response, etc.)

Settings

Member Visibility

Theme

On This Page

contextUserconversationIddataContextdataSourceforceEntityRefreshincludeCallbackAuthincludeEntitiesincludeNotesincludeQueriesincludeRequestsmessagesonStatusUpdatepayloadrequestPhase