Type alias SkipAPIArtifactRequest

SkipAPIArtifactRequest: {
    action: "new_artifact" | "new_artifact_version";
    artifactId?: string;
    description: string;
    name: string;
}

Defines the shape of the data that is used to request an artifact from the Skip API Server

action: "new_artifact" | "new_artifact_version"
The agent should request new_artifact if an entirely new artifact should be created. This should be selected if there are no existing artifacts in the conversation, OR if the user has asked for something that is not logically related to existing artifacts for the given conversation and it makes more sense to create a new artifact entirely.

new_artifact_version, on the other hand, should be used when the user has asked for something that is logically related to an existing artifact and it is most logical to add a new version to that existing artifact for example iterating on various versions of a report over time.
Optional artifactId?: string
This is only provided when action === 'new_artifact_version' and is used to indicate the artifact that a new version is being added to. When action == 'new_artifact' this property is not used.
description: string
The description of the artifact or artifact version that is being created. Generated by the AI agent.
name: string
The name of the artifact or artifact version that is being created. Generated by the AI agent.