• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    AI Platform (AIP)AI FDEPre-fill sessions with URL parameters

    Pre-fill sessions with URL parameters

    You can link to AI FDE with a prompt and AIP skills already loaded into a new session. Use pre-filled links to share a repeatable starting point with other users, or to launch AI FDE from documentation, Workshop modules, or other applications.

    Build a pre-fill link

    Pre-fill links use the /workspace/ai-fde/prefill path followed by any combination of the URL parameters below. All parameters are optional. When a user opens the link, AI FDE creates a new session with the provided context.

    • prompt: Pre-populates the first message of the session.
    • skillRid: Adds an AIP skill to the session context, for example ri.aip-skill.main.skill.... Repeat the parameter to add multiple skills.
    • autoStart: When true, AI FDE begins working as soon as the page loads, without waiting for the user to send the message. Defaults to false, which lets users review and edit the pre-filled context before starting. Has no effect unless prompt or skillRid is also set.

    Values must be URL-encoded. For example, a space in a prompt must be encoded as %20.

    Examples

    Hand off from a Workshop module

    You can add a button to a Workshop module that links to AI FDE with the module's own resource identifier. Then, users can request a change to the module they are viewing and AI FDE will start working on the request immediately:

    Copied!
    1
/workspace/ai-fde/prefill?prompt=Add+a+filter+on+order+status+to+the+orders+table+in+the+Workshop+module+ri.workshop.main.module.abc123&autoStart=true

    Put longer, reusable instructions in an AIP skill and reference it with skillRid, then use prompt for the request-specific details. Skills are easier to maintain than long prompts embedded in links, since you can update a skill once without changing every link that uses it. You can build the prompt value directly from Workshop variables, such as the selected object or a user's text input, so each link reflects the current context.

    Share a prompt template with a skill

    You can pre-fill a structured request for users to complete before sending, with a skill attached. This helps ensure that the result will follow your team's standards:

    Copied!
    1
/workspace/ai-fde/prefill?skillRid=ri.aip-skill.main.skill.abc123&prompt=Build+a+pipeline+that+ingests+[source]+into+the+[object+type]+object+type

    Onboard new team members

    You can link to a session that walks new team members through a project, without starting automatically. This enables users to adjust the prompt first:

    Copied!
    1
/workspace/ai-fde/prefill?skillRid=ri.aip-skill.main.skill.abc123&prompt=Give+me+an+overview+of+this+project%27s+pipelines+and+ontology

    Sessions started with autoStart=true follow the same tool approval settings as any other session, so users are still asked to approve tools before they make changes.