Class SkipAPIRequest

One or more API keys that are used for AI systems that Skip will access on behalf of the API caller NOTE: This is not where you put in the bearer token for the Skip API server itself, that goes in the header of the request

Optional, array of artifacts that already exist for the given conversation.

Optional, if the calling server wants to enable the AI agent to call back to interact and request data or otherwise, this is the API key that the AI agent can use to call back to the source server

Optional, if the calling server requires the use of an additional short-lived access token beyond the API key, this is the token that the AI agent can use to call back to the source server during the lifecycle of the request

Optional, if the calling server wants to enable the AI agent to call back to interact and request data or otherwise, this is the URL that the AI agent can use to call back to the source server

The conversation ID

The data context, use this to provide all of the data you have in a data context to Skip. You should provide this from cache or refreshed based on the parameters provided by the user.

Summary entity metadata that is passed into the Skip Server so that Skip has knowledge of the schema of the calling MJAPI environment

An array of 1 or more messages that are part of the conversation. The Skip API server will use these messages to understand the context of the conversation. When Skip responds to a request, he provides a messages array as well that will include the input messages as well as additional messages that he has generated as part of the conversation. In future requests for the same conversation it is important to include ALL of the messages that have been part of the conversation so far, so that Skip can understand the full context of the conversation.

Optional, list of the possible types of notes that an agent can store in the source MJ system

Optional notes that can be passed to Skip for additional context

The organization ID - this is part of the Skip API Authentication Request, along with the bearer token in the header

This is an optional string parameter where you can tell Skip anything you'd like to share about your organization, structure, database schema, and anything else that might be helpful for him to be aware of. Keep in mind that this organizationInfo will be incorprorated into every request Skip makes to the underlying AI services which can add cost and processing time to your requests. Including this information is extremely helpful as a very simple method of contextualizing Skip for your organization. In the Pro and above Skip plans, there are far more granular and effect methods of training Skip beyond this organizationInfo parameter, contact the team at MemberJunction.com for more information if you're interested.

Optional payload data that was returned from a previous response. When the Skip API returns a response with a payload (e.g., a PRD from Requirements Expert), the client should pass that payload back in the next request so the agent can continue building on it.

This enables incremental artifact building where structured data accumulates throughout the conversation. The payload is separate from artifacts - it represents work-in-progress data that hasn't been finalized yet.

Stored queries in the MJ metadata that Skip can use and learn from

The request phase, defined within the SkipRequestPhase type

The user email of the person making the request - this is part of the Skip API Authentication Request, along with the bearer token in the header