Skip to main content

Text Input

The Text Input component provides a simple way to capture textual data that can be used in subsequent steps of your workflow. It's one of the fundamental building blocks for creating interactive workflows.

Credit Cost​

Free

Usage​

The Text Input component has a single output handle that passes along the entered text data. When a user provides text through the interface or API, that text data flows through the output handle to the next connected component. If no text is provided, the component will output empty data.

Properties​

Identifier​

Input Order​

  • Type: number
  • Description: The order in which the text field will appear in the playground UI. Lower values appear first.

Playground Size​

  • Type: option
  • Description: The size of the text field in the playground UI. Small is around 25% of the screen, medium is around 50% of the screen, and large is the full width of the screen.

API Usage​

When using the Text Input component through the API, provide the input value as a string in your request body.

Single Input Example​

For a workflow with one Text Input component (identifier: "Input A"):

{
  "input": {
    "Input A": "Hello, world!"
  }
}

Multiple Inputs Example​

For a workflow with multiple Text Input components:

{
  "input": {
    "First Name": "John",
    "Last Name": "Doe",
    "Comments": "This is a sample comment"
  }
}