feat(ui): deploy modal + copilot advertise the v2 execute surface

All 20 API-tab snippets move to POST /api/v2/workflows/{id}/execute with
the nested {"input": ...} body, async as the "async": true body flag
(X-Execution-Mode gone), status polling against the v2 executions
resource, the third tab renamed Usage and pointed at
/api/v2/billing/usage, and {data} envelope unwraps in the printed
responses. Fixes the latent baseUrl derivation
(endpoint.split('/api/workflows/')) that would have silently built
garbage URLs under a v2 endpoint, and deletes dead code (exampleCommand
across 3 sites, getAsyncExampleTitle). Copilot deploy/manage/serializer
endpoint builders and the api_trigger bestPractices example follow (the
latter also drops its hardcoded staging host).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CiHhAk2R1NryaS3R8n2yFz

Author: TheodoreSpeaks

apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/deploy/components/deploy-modal/components/api/api.tsx

@@ -12,6 +12,7 @@ import {
   Tooltip,
 } from '@sim/emcn'
 import { Check, Clipboard } from 'lucide-react'
+import { getBaseUrl } from '@/lib/core/utils/urls'
 import {
   AGENT_STREAM_PROTOCOL_HEADER_LABEL,
   AGENT_STREAM_PROTOCOL_V1,
@@ -24,7 +25,6 @@ interface WorkflowDeploymentInfo {
   deployedAt?: string
   apiKey: string
   endpoint: string
-  exampleCommand: string
   needsRedeployment: boolean
   isPublicApi?: boolean
 }
@@ -39,7 +39,7 @@ interface ApiDeployProps {
   onSelectedStreamingOutputsChange: (outputs: string[]) => void
 }
 
-type AsyncExampleType = 'execute' | 'status' | 'rate-limits'
+type AsyncExampleType = 'execute' | 'status' | 'usage'
 type CodeLanguage = 'curl' | 'python' | 'javascript' | 'typescript'
 
 type CopiedState = {
@@ -97,19 +97,23 @@ export function ApiDeploy({
     return info.endpoint.replace(info.apiKey, '$SIM_API_KEY')
   }
 
-  const getPayloadObject = (): Record<string, unknown> => {
+  /** The workflow's example input fields, parsed from the shared example command. */
+  const getInputObject = (): Record<string, unknown> => {
     const inputExample = getInputFormatExample ? getInputFormatExample(false) : ''
     const match = inputExample.match(/-d\s*'([\s\S]*)'/)
     if (match) {
       try {
         return JSON.parse(match[1]) as Record<string, unknown>
       } catch {
-        return { input: 'your data here' }
+        return { key: 'value' }
       }
     }
-    return { input: 'your data here' }
+    return { key: 'value' }
   }
 
+  /** v2 body: the input nests under `input`; control fields are siblings. */
+  const getPayloadObject = (): Record<string, unknown> => ({ input: getInputObject() })
+
   const getStreamPayloadObject = (): Record<string, unknown> => {
     const payload: Record<string, unknown> = { ...getPayloadObject(), stream: true }
     if (selectedStreamingOutputs && selectedStreamingOutputs.length > 0) {
@@ -148,7 +152,7 @@ ${isPublic ? '' : '        "X-API-Key": os.environ.get("SIM_API_KEY"),\n'}
     json=${JSON.stringify(payload, null, 4).replace(/\n/g, '\n    ')}
 )
 
-print(response.json())`
+print(response.json()["data"])`
 
       case 'javascript':
         return `const response = await fetch("${endpoint}", {
@@ -159,7 +163,7 @@ ${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Typ
   body: JSON.stringify(${JSON.stringify(payload)})
 });
 
-const data = await response.json();
+const { data } = await response.json();
 console.log(data);`
 
       case 'typescript':
@@ -171,7 +175,7 @@ ${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Typ
   body: JSON.stringify(${JSON.stringify(payload)})
 });
 
-const data: Record<string, unknown> = await response.json();
+const { data }: { data: Record<string, unknown> } = await response.json();
 console.log(data);`
 
       default:
@@ -261,8 +265,8 @@ while (true) {
   const getAsyncCommand = (): string => {
     if (!info) return ''
     const endpoint = getBaseEndpoint()
-    const baseUrl = endpoint.split('/api/workflows/')[0]
-    const payload = getPayloadObject()
+    const baseUrl = getBaseUrl()
+    const payload = { ...getPayloadObject(), async: true }
     const isPublic = info.isPublicApi
 
     switch (asyncExampleType) {
@@ -271,7 +275,6 @@ while (true) {
           case 'curl':
             return `curl -X POST \\
 ${isPublic ? '' : '  -H "X-API-Key: $SIM_API_KEY" \\\n'}  -H "Content-Type: application/json" \\
-  -H "X-Execution-Mode: async" \\
   -d '${JSON.stringify(payload)}' \\
   ${endpoint}`
 
@@ -282,40 +285,38 @@ import requests
 response = requests.post(
     "${endpoint}",
     headers={
-${isPublic ? '' : '        "X-API-Key": os.environ.get("SIM_API_KEY"),\n'}        "Content-Type": "application/json",
-        "X-Execution-Mode": "async"
+${isPublic ? '' : '        "X-API-Key": os.environ.get("SIM_API_KEY"),\n'}        "Content-Type": "application/json"
     },
     json=${JSON.stringify(payload, null, 4).replace(/\n/g, '\n    ')}
 )
 
-job = response.json()
-print(job)  # Contains jobId and executionId`
+job = response.json()["data"]
+print(job)  # Contains executionId and statusUrl`
 
           case 'javascript':
             return `const response = await fetch("${endpoint}", {
   method: "POST",
   headers: {
-${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Type": "application/json",
-    "X-Execution-Mode": "async"
+${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Type": "application/json"
   },
   body: JSON.stringify(${JSON.stringify(payload)})
 });
 
-const job = await response.json();
-console.log(job); // Contains jobId and executionId`
+const { data: job } = await response.json();
+console.log(job); // Contains executionId and statusUrl`
 
           case 'typescript':
             return `const response = await fetch("${endpoint}", {
   method: "POST",
   headers: {
-${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Type": "application/json",
-    "X-Execution-Mode": "async"
+${isPublic ? '' : '    "X-API-Key": process.env.SIM_API_KEY,\n'}    "Content-Type": "application/json"
   },
   body: JSON.stringify(${JSON.stringify(payload)})
 });
 
-const job: { jobId: string; executionId: string } = await response.json();
-console.log(job); // Contains jobId and executionId`
+const { data: job }: { data: { executionId: string; statusUrl: string } } =
+  await response.json();
+console.log(job); // Poll statusUrl until status is terminal`
 
           default:
             return ''
@@ -325,84 +326,84 @@ console.log(job); // Contains jobId and executionId`
         switch (language) {
           case 'curl':
             return `curl -H "X-API-Key: $SIM_API_KEY" \\
-  ${baseUrl}/api/jobs/JOB_ID_FROM_EXECUTION`
+  ${baseUrl}/api/v2/workflows/${workflowId}/executions/EXECUTION_ID`
 
           case 'python':
             return `import os
 import requests
 
 response = requests.get(
-    "${baseUrl}/api/jobs/JOB_ID_FROM_EXECUTION",
+    "${baseUrl}/api/v2/workflows/${workflowId}/executions/EXECUTION_ID",
     headers={"X-API-Key": os.environ.get("SIM_API_KEY")}
 )
 
-status = response.json()
-print(status)`
+status = response.json()["data"]
+print(status)  # status: queued | running | completed | failed | cancelled | paused`
 
           case 'javascript':
             return `const response = await fetch(
-  "${baseUrl}/api/jobs/JOB_ID_FROM_EXECUTION",
+  "${baseUrl}/api/v2/workflows/${workflowId}/executions/EXECUTION_ID",
   {
     headers: { "X-API-Key": process.env.SIM_API_KEY }
   }
 );
 
-const status = await response.json();
+const { data: status } = await response.json();
 console.log(status);`
 
           case 'typescript':
             return `const response = await fetch(
-  "${baseUrl}/api/jobs/JOB_ID_FROM_EXECUTION",
+  "${baseUrl}/api/v2/workflows/${workflowId}/executions/EXECUTION_ID",
   {
     headers: { "X-API-Key": process.env.SIM_API_KEY }
   }
 );
 
-const status: Record<string, unknown> = await response.json();
+const { data: status }: { data: Record<string, unknown> } = await response.json();
 console.log(status);`
 
           default:
             return ''
         }
 
-      case 'rate-limits':
+      case 'usage':
         switch (language) {
           case 'curl':
             return `curl -H "X-API-Key: $SIM_API_KEY" \\
-  ${baseUrl}/api/users/me/usage-limits`
+  ${baseUrl}/api/v2/billing/usage`
 
           case 'python':
             return `import os
 import requests
 
 response = requests.get(
-    "${baseUrl}/api/users/me/usage-limits",
+    "${baseUrl}/api/v2/billing/usage",
     headers={"X-API-Key": os.environ.get("SIM_API_KEY")}
 )
 
-limits = response.json()
-print(limits)`
+limits = response.json()["data"]
+print(limits)  # totalCredits + bySourceCredits breakdown`
 
           case 'javascript':
             return `const response = await fetch(
-  "${baseUrl}/api/users/me/usage-limits",
+  "${baseUrl}/api/v2/billing/usage",
   {
     headers: { "X-API-Key": process.env.SIM_API_KEY }
   }
 );
 
-const limits = await response.json();
+const { data: limits } = await response.json();
 console.log(limits);`
 
           case 'typescript':
             return `const response = await fetch(
-  "${baseUrl}/api/users/me/usage-limits",
+  "${baseUrl}/api/v2/billing/usage",
   {
     headers: { "X-API-Key": process.env.SIM_API_KEY }
   }
 );
 
-const limits: Record<string, unknown> = await response.json();
+const { data: limits }: { data: Record<string, unknown> } = await response.json();
 console.log(limits);`
 
           default:
@@ -414,19 +415,6 @@ console.log(limits);`
     }
   }
 
-  const getAsyncExampleTitle = () => {
-    switch (asyncExampleType) {
-      case 'execute':
-        return 'Execute Job'
-      case 'status':
-        return 'Check Status'
-      case 'rate-limits':
-        return 'Usage Limits'
-      default:
-        return 'Execute Job'
-    }
-  }
-
   const handleCopy = (key: keyof CopiedState, value: string) => {
     navigator.clipboard.writeText(value)
     setCopied((prev) => ({ ...prev, [key]: true }))
@@ -564,7 +552,7 @@ console.log(limits);`
               options={[
                 { label: 'Execute Job', value: 'execute' },
                 { label: 'Check Status', value: 'status' },
-                { label: 'Usage Limits', value: 'rate-limits' },
+                { label: 'Usage', value: 'usage' },
               ]}
               value={asyncExampleType}
               onChange={(value) => setAsyncExampleType(value as AsyncExampleType)}

apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/deploy/components/deploy-modal/deploy-modal.tsx

@@ -77,7 +77,6 @@ interface WorkflowDeploymentInfoUI {
   deployedAt?: string
   apiKey: string
   endpoint: string
-  exampleCommand: string
   needsRedeployment: boolean
   isPublicApi: boolean
 }
@@ -234,7 +233,7 @@ export function DeployModal({
       return null
     }
 
-    const endpoint = `${getBaseUrl()}/api/workflows/${workflowId}/execute`
+    const endpoint = `${getBaseUrl()}/api/v2/workflows/${workflowId}/execute`
     const inputFormatExample = getInputFormatExample(selectedStreamingOutputs.length > 0)
     const placeholderKey = getApiHeaderPlaceholder()
 
@@ -243,7 +242,6 @@ export function DeployModal({
       deployedAt: deploymentInfoData.deployedAt ?? undefined,
       apiKey: getApiKeyLabel(deploymentInfoData.apiKey),
       endpoint,
-      exampleCommand: `curl -X POST -H "X-API-Key: ${placeholderKey}" -H "Content-Type: application/json"${inputFormatExample} ${endpoint}`,
       needsRedeployment: deploymentInfoData.needsRedeployment,
       isPublicApi: isPublicApiDisabled ? false : (deploymentInfoData.isPublicApi ?? false),
     }

apps/sim/blocks/blocks/api_trigger.ts

@@ -11,7 +11,7 @@ export const ApiTriggerBlock: BlockConfig = {
   bestPractices: `
   - Can run the workflow manually to test implementation when this is the trigger point.
   - The input format determines variables accesssible in the following blocks. E.g. <api1.paramName>. You can set the value in the input format to test the workflow manually.
-  - In production, the curl would come in as e.g. curl -X POST -H "X-API-Key: $SIM_API_KEY" -H "Content-Type: application/json" -d '{"paramName":"example"}' https://www.staging.sim.ai/api/workflows/9e7e4f26-fc5e-4659-b270-7ea474b14f4a/execute -- If user asks to test via API, you might need to clarify the API key.
+  - In production, the curl would come in as e.g. curl -X POST -H "X-API-Key: $SIM_API_KEY" -H "Content-Type: application/json" -d '{"input":{"paramName":"example"}}' https://www.sim.ai/api/v2/workflows/9e7e4f26-fc5e-4659-b270-7ea474b14f4a/execute -- If user asks to test via API, you might need to clarify the API key.
   `,
   category: 'triggers',
   hideFromToolbar: true,

apps/sim/lib/copilot/tools/handlers/deployment/deploy.ts

@@ -30,7 +30,7 @@ import { ensureWorkflowAccess } from '../access'
 import type { DeployApiParams, DeployChatParams, DeployMcpParams } from '../param-types'
 
 function buildWorkflowApiEndpoint(baseUrl: string, workflowId: string): string {
-  return `${baseUrl}/api/workflows/${workflowId}/execute`
+  return `${baseUrl}/api/v2/workflows/${workflowId}/execute`
 }
 
 function buildWorkflowApiConfig(baseUrl: string, apiEndpoint: string) {
@@ -57,9 +57,8 @@ function buildWorkflowApiConfig(baseUrl: string, apiEndpoint: string) {
         method: 'POST',
         transport: 'json',
         stream: false,
-        headers: { 'X-Execution-Mode': 'async' },
-        body: { input: { key: 'value' } },
-        jobStatusEndpointTemplate: `${baseUrl}/api/jobs/{jobId}`,
+        body: { async: true, input: { key: 'value' } },
+        jobStatusEndpointTemplate: `${baseUrl}/api/v2/workflows/{workflowId}/executions/{executionId}`,
       },
     },
   }
@@ -78,9 +77,8 @@ function buildWorkflowApiExamples(baseUrl: string, apiEndpoint: string) {
     async: `curl -X POST "${apiEndpoint}" \\
   -H "Content-Type: application/json" \\
   -H "X-API-Key: YOUR_API_KEY" \\
-  -H "X-Execution-Mode: async" \\
-  -d '{"input":{"key":"value"}}'`,
-    poll: `curl "${baseUrl}/api/jobs/JOB_ID" \\
+  -d '{"async":true,"input":{"key":"value"}}'`,
+    poll: `curl "${baseUrl}/api/v2/workflows/WORKFLOW_ID/executions/EXECUTION_ID" \\
   -H "X-API-Key: YOUR_API_KEY"`,
   }
 }

apps/sim/lib/copilot/tools/handlers/deployment/manage.ts

@@ -82,7 +82,7 @@ export async function executeCheckDeploymentStatus(
     const apiDetails = {
       isDeployed: isApiDeployed,
       deployedAt: apiDeploy[0]?.deployedAt || null,
-      endpoint: isApiDeployed ? `/api/workflows/${workflowId}/execute` : null,
+      endpoint: isApiDeployed ? `/api/v2/workflows/${workflowId}/execute` : null,
       apiKey: workflowRecord.workspaceId ? 'Workspace API keys' : 'Personal API keys',
       needsRedeployment,
       activeDeployment: deploymentSummary.activeDeployment,

apps/sim/lib/copilot/vfs/serializers.ts

@@ -808,7 +808,7 @@ export function serializeDeployments(data: DeploymentData): string {
     result.api = {
       isDeployed: true,
       deployedAt: data.deployedAt?.toISOString(),
-      apiEndpoint: `/api/workflows/${data.workflowId}/execute`,
+      apiEndpoint: `/api/v2/workflows/${data.workflowId}/execute`,
       ...(data.api ? { version: data.api.version } : {}),
     }
   }