Optional analysisAn analysis of the component, the data and the formatted component output.
Optional artifactIf the AI Agent decides it would be best to display the result in an artifact, this information can be used by the calling application to properly associate this specific response with the artifact that is being created. This is typically used for output that is likely to have iterations where artifacts are a clean way of managing a UI in the calling application where you can show multiple versions/etc.
Optional componentContains a list of all the possible components that were generated (1 or more) for the given request.
The data context that was passed in with the request, this is used to know the source data at the time the process was executed and for simple persistence.
Optional drillInformation that will support a drill-down experience in the component UI
This property is only used if success is false, and contains an error message that describes the reason for the failure
Optional executionThe results of the execution of the sub-process to run the server-side script
An array of messages including the messaged passed in with the SkipAPIRequest object as well as any additional messages that Skip generates as part of the conversation.
Optional newWhen provided, this array of data requests indicate to the caller of the Skip API that Skip was able to retrieve, on his own, additional data BEYOND what was provided in the SkipAPIRequest object. The caller of the Skip API should update its internal representation of its data context to include these new data items so that they will be run and provided to Skip for future iterations/requests and for re-running components as well.
Optional payloadOptional payload data from the agent. When provided, the calling application can render this payload as an artifact for the user to review/edit. This enables incremental artifact building where the payload is passed back and forth between the user and agent, accumulating structured data throughout the conversation.
Common use case: Requirements Expert emits a PRD with functionalRequirements, title, type, userExplanation etc. in the payload. The client renders this as an artifact for user review. When user responds, the client passes the payload back in the next SkipAPIRequest.payload field.
Optional reportLegacy property that is no longer used, but is kept for backwards compatibility
This property is no longer used and will be removed in a future version. Use the title property instead.
The Skip API server response phase, defined within the SkipResponsePhase type
The type of component generated, data is a simple table, plot is a chart and interactive is a custom interactive component For data/plot types, the results will be server-generated and available in the executionResults property For interactive type, the executionResults will be null because the server generates an interactive component that is intended to run on the client.
Optional scriptThe script text that was used to generated the component and can be saved to be run again later
Used for all response phases, to indicate if the API request was successful or not
Optional suggestedZero or more suggested questions that the AI engine suggests might be good follow up questions to ask after reviewing the provided component
Optional tableDescribes each column in the component's computed data output that is what is displayed in either a table or a chart
Optional techA more detailed technical explanation of what the component does and how it works
Optional titleThe title of the component
Optional userA user-friendly explanation of what the component does
Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'analysis_complete'