Merge pull request #4152 from Agenta-AI/fix/update-ui-code-snippets-v96-invoke

fix(frontend): Update UI code snippets to v0.96.0 unified invoke API

Author: jp-agenta

web/oss/src/code_snippets/endpoints/fetch_config/curl.ts

@@ -1,15 +1,15 @@
 import {getEnv} from "@/oss/lib/helpers/dynamicEnv"
 
 export default function cURLCode(appName: string, env_name: string, apiKey: string): string {
-    return `curl -L '${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/variants/configs/fetch' \\
+    return `curl -X POST '${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/preview/applications/revisions/retrieve' \\
 -H 'Content-Type: application/json' \\
 -H "Authorization: ApiKey ${apiKey}" \\
 -d '{
-    "environment_ref": {
-        "slug": "${env_name}"
-    },
     "application_ref": {
         "slug": "${appName}"
+    },
+    "environment_ref": {
+        "slug": "${env_name}"
     }
 }'
 `

web/oss/src/code_snippets/endpoints/fetch_config/typescript.ts

@@ -6,16 +6,16 @@ export default function tsCode(appName: string, env_name: string, apiKey: string
     const codeString = `import axios from 'axios';
 
 const getConfig = async (appName: string, environmentSlug: string) => {
-    const baseUrl = '${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/variants/configs/fetch';
+    const baseUrl = '${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/preview/applications/revisions/retrieve';
 
     try {
         const response = await axios.post(baseUrl, {
-            environment_ref: {
-                slug: environmentSlug,
-            },
             application_ref: {
                 slug: appName,
             },
+            environment_ref: {
+                slug: environmentSlug,
+            },
         }, {
             headers: {
                 'Content-Type': 'application/json',

web/oss/src/code_snippets/endpoints/fetch_variant/curl.ts

@@ -6,16 +6,18 @@ export const buildCurlSnippet = (
     variantVersion: number,
     apiKey: string,
 ) => {
-    return `curl -X POST "${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/variants/configs/fetch" \\
+    return `curl -X POST "${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/preview/applications/revisions/retrieve" \\
   -H "Content-Type: application/json" \\
   -H "Authorization: ApiKey ${apiKey}" \\
   -d '{
-    "variant_ref": {
-      "slug": "${variantSlug}",
-      "version": ${variantVersion}
-    },
     "application_ref": {
       "slug": "${appSlug}"
+    },
+    "application_variant_ref": {
+      "slug": "${variantSlug}"
+    },
+    "application_revision_ref": {
+      "version": "${variantVersion}"
     }
   }'
 `

web/oss/src/code_snippets/endpoints/fetch_variant/typescript.ts

@@ -6,20 +6,22 @@ export const buildTypescriptSnippet = (
     variantVersion: number,
     apiKey: string,
 ) => {
-    return `const fetchResponse = await fetch('${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/variants/configs/fetch', {
+    return `const fetchResponse = await fetch('${getEnv("NEXT_PUBLIC_AGENTA_API_URL")}/preview/applications/revisions/retrieve', {
     method: 'POST',
     headers: {
         'Content-Type': 'application/json',
         'Authorization': 'ApiKey ${apiKey}',
     },
     body: JSON.stringify({
-        variant_ref: {
-            slug: '${variantSlug}',
-            version: ${variantVersion},
-        },
         application_ref: {
             slug: '${appSlug}',
         },
+        application_variant_ref: {
+            slug: '${variantSlug}',
+        },
+        application_revision_ref: {
+            version: '${variantVersion}',
+        },
     }),
 });
 

web/oss/src/code_snippets/endpoints/invoke_llm_app/curl.ts

@@ -1,6 +1,6 @@
 export default function cURLCode(uri: string, params: string, apiKey: string): string {
     const parsedParams = JSON.parse(params)
-    const isChat = parsedParams.messages !== undefined
+    const isChat = parsedParams?.data?.inputs?.messages !== undefined
 
     return `curl -X POST "${uri}" \\
 -H "Content-Type: application/json" \\

web/oss/src/code_snippets/endpoints/invoke_llm_app/python.ts

@@ -1,6 +1,6 @@
 export default function pythonCode(uri: string, params: string, apiKey: string): string {
     const parsedParams = JSON.parse(params)
-    const isChat = parsedParams.messages !== undefined
+    const isChat = parsedParams?.data?.inputs?.messages !== undefined
 
     return `import requests
 import json

web/oss/src/code_snippets/endpoints/invoke_llm_app/typescript.ts

@@ -2,7 +2,7 @@ import {js as beautify} from "js-beautify"
 
 export default function tsCode(uri: string, params: string, apiKey: string): string {
     const parsedParams = JSON.parse(params)
-    const isChat = parsedParams.messages !== undefined
+    const isChat = parsedParams?.data?.inputs?.messages !== undefined
 
     const codeString = `import axios from 'axios';
 

web/oss/src/components/DeploymentsDashboard/assets/UseApiContent.tsx

@@ -70,7 +70,7 @@ const UseApiContent = ({
         return createParams(synthesized, envName || "none", "add_a_value", currentApp)
     }, [variableNames, envName, currentApp])
 
-    // deploymentUrl resolves to /run (resolves config from the deployed environment).
+    // deploymentUrl resolves to /v0/invoke (resolves config from the deployed environment).
     const invokeLlmUrl = useMemo(() => uri?.trim() || "", [uri])
 
     const invokeLlmAppCodeSnippet = useMemo(

web/oss/src/components/DeploymentsDashboard/assets/VariantUseApiContent.tsx

@@ -151,37 +151,33 @@ const VariantUseApiContent = ({initialRevisionId}: VariantUseApiContentProps) =>
     const params = useMemo(() => {
         const synthesized = variableNames.map((name) => ({name, input: name === "messages"}))
 
-        const mainParams: Record<string, any> = {}
-        const secondaryParams: Record<string, any> = {}
+        const inputs: Record<string, any> = {}
 
         synthesized.forEach((item) => {
-            if (item.input) {
-                mainParams[item.name] = "add_a_value"
-            } else {
-                secondaryParams[item.name] = "add_a_value"
-            }
+            inputs[item.name] = "add_a_value"
         })
 
         const hasMessagesParam = synthesized.some((p) => p?.name === "messages")
         const isChat = !!currentApp?.flags?.is_chat || hasMessagesParam
         if (isChat) {
-            mainParams["messages"] = [
+            inputs["messages"] = [
                 {
                     role: "user",
                     content: "",
                 },
             ]
-            mainParams["inputs"] = secondaryParams
-        } else if (Object.keys(secondaryParams).length > 0) {
-            mainParams["inputs"] = secondaryParams
         }
 
-        // Use variant refs instead of environment
-        mainParams["app"] = appSlug
-        mainParams["variant_slug"] = variantSlug
-        mainParams["variant_version"] = variantVersion
+        const params: Record<string, any> = {
+            data: {inputs},
+            references: {
+                application: {slug: appSlug},
+                application_variant: {slug: variantSlug},
+                application_revision: {version: String(variantVersion)},
+            },
+        }
 
-        return JSON.stringify(mainParams, null, 2)
+        return JSON.stringify(params, null, 2)
     }, [variableNames, currentApp?.flags?.is_chat, appSlug, variantSlug, variantVersion])
 
     const fetchConfigCodeSnippet = useMemo(

web/oss/src/pages/w/[workspace_id]/p/[project_id]/apps/[app_id]/endpoints/index.tsx

@@ -70,27 +70,30 @@ const createParamsFromSchema = (
     isChat: boolean,
     appName: string | null,
 ): string => {
-    const mainParams: GenericObject = {}
+    const inputs: GenericObject = {}
 
     if (inputSchema) {
         const properties = inputSchema.properties as Record<string, unknown> | undefined
         if (properties) {
             for (const [key, schemaDef] of Object.entries(properties)) {
                 const schema = schemaDef as Record<string, unknown> | undefined
-                mainParams[key] = schema?.default ?? "add_a_value"
+                inputs[key] = schema?.default ?? "add_a_value"
             }
         }
     }
 
     if (isChat) {
-        mainParams["messages"] = [{role: "user", content: ""}]
+        inputs["messages"] = [{role: "user", content: ""}]
     }
 
-    mainParams["environment"] = environmentName
-    if (appName) {
-        mainParams["app"] = appName
+    const params: GenericObject = {
+        data: {inputs},
+        references: {
+            ...(appName ? {application: {slug: appName}} : {}),
+            environment: {slug: environmentName},
+        },
     }
-    return JSON.stringify(mainParams, null, 2)
+    return JSON.stringify(params, null, 2)
 }
 
 /**
@@ -103,32 +106,32 @@ export const createParams = (
     value: string | number,
     app?: {name?: string | null; slug?: string; flags?: {is_chat?: boolean}} | null,
 ) => {
-    const mainParams: GenericObject = {}
-    const secondaryParams: GenericObject = {}
+    const inputs: GenericObject = {}
 
     inputParams?.forEach((item) => {
         if (item.input) {
-            mainParams[item.name] = item.default || value
+            inputs[item.name] = item.default || value
         } else {
-            secondaryParams[item.name] = item.default || value
+            inputs[item.name] = item.default || value
         }
     })
     const hasMessagesParam = Array.isArray(inputParams)
         ? inputParams.some((p) => p?.name === "messages")
         : false
     const isChat = !!app?.flags?.is_chat || hasMessagesParam
     if (isChat) {
-        mainParams["messages"] = [{role: "user", content: ""}]
-        mainParams["inputs"] = secondaryParams
-    } else if (Object.keys(secondaryParams).length > 0) {
-        mainParams["inputs"] = secondaryParams
+        inputs["messages"] = [{role: "user", content: ""}]
     }
 
-    mainParams["environment"] = environmentName
-    if (app) {
-        mainParams["app"] = app.name ?? app.slug
+    const appSlug = app?.name ?? app?.slug
+    const params: GenericObject = {
+        data: {inputs},
+        references: {
+            ...(appSlug ? {application: {slug: appSlug}} : {}),
+            environment: {slug: environmentName},
+        },
     }
-    return JSON.stringify(mainParams, null, 2)
+    return JSON.stringify(params, null, 2)
 }
 
 export default function VariantEndpoint() {