cURL command in API section is not accurate

[maxpaynebupt]

Bug Description

the example's output_type value should be quoted.

Reproduction

setup a flow , and try to call it.

Expected behavior

copy the command and paste it should be OK to run.

Who can help?

No response

Operating System

Docker image v1.0.15

Langflow Version

v1.0.15

Python Version

None

Screenshot

No response

Flow File

No response

[dosubot]

The cURL command example in the API section should indeed quote the output_type value in the JSON payload. Here is the corrected version of the getCurlRunCode function:

import useFlowStore from "@/stores/flowStore";

/**
 * Function to get the curl code for the API
 * @param {string} flowId - The id of the flow
 * @param {boolean} isAuth - If the API is authenticated
 * @returns {string} - The curl code
 */
export function getCurlRunCode(
  flowId: string,
  isAuth: boolean,
  tweaksBuildedObject?: {},
  endpointName?: string | null,
): string {
  let tweaksString = "{}";
  const inputs = useFlowStore.getState().inputs;
  const outputs = useFlowStore.getState().outputs;
  const hasChatInput = inputs.some((input) => input.type === "ChatInput");
  const hasChatOutput = outputs.some((output) => output.type === "ChatOutput");
  if (tweaksBuildedObject)
    tweaksString = JSON.stringify(tweaksBuildedObject, null, 2);
  // show the endpoint name in the curl command if it exists
  return `curl -X POST \\
    "${window.location.protocol}//${window.location.host}/api/v1/run/${
      endpointName || flowId
    }?stream=false" \\
    -H 'Content-Type: application/json'\\${
      !isAuth ? `\n  -H 'x-api-key: <your api key>'\\` : ""
    }
    -d '{"input_value": "message",
    "output_type": "${hasChatOutput ? 'chat' : 'text'}",
    "input_type": "${hasChatInput ? 'chat' : 'text'}",
    "tweaks": ${tweaksString}}'
    `;
}

/**
 * Generates a cURL command for making a POST request to a webhook endpoint.
 *
 * @param {Object} options - The options for generating the cURL command.
 * @param {string} options.flowId - The ID of the flow.
 * @param {boolean} options.isAuth - Indicates whether authentication is required.
 * @param {string} options.endpointName - The name of the webhook endpoint.
 * @returns {string} The cURL command.
 */
export function getCurlWebhookCode(
  flowId,
  isAuth,
  endpointName?: string | null,
) {
  return `curl -X POST \\
  "${window.location.protocol}//${window.location.host}/api/v1/webhook/${
    endpointName || flowId
  }" \\
  -H 'Content-Type: application/json'\\${
    !isAuth ? `\n  -H 'x-api-key: <your api key>'\\` : ""
  }
  -d '{"any": "data"}'
  `;
}

This update ensures that the output_type value is correctly quoted in the JSON payload ^[1].

To continue talking to Dosu, mention @dosu.

[uladkaminski]

Issue was recently fixed by #3337

[carlosrcoelho]

#3337