---
updatedAt: 2025-11-03T19:36:26.000Z
agentTools:
  projectIndex: https://docs.staxpayments.com/llms.txt
---

# Prompt (Input)

Displays a text input prompt on the terminal for the customer or clerk to enter free-form data (e.g., table number, PO reference). Returns the entered string in the response.

Usage:
- Provide `register`.
- Optional `title` customizes terminal screen header.

Considerations: Length and character restrictions depend on device; keep alphanumeric to ensure compatibility. Provide client-side validation if a specific format is needed.

Security: ApiKeyAuth or EphemeralAuth.

Errors: Cancelled entry, timeout, unsupported character input.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "stax-api",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://apiprod.fattlabs.com/"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality."
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/terminal/promptInput": {
      "post": {
        "summary": "Prompt (Input)",
        "description": "Displays a text input prompt on the terminal for the customer or clerk to enter free-form data (e.g., table number, PO reference). Returns the entered string in the response.\n\nUsage:\n- Provide `register`.\n- Optional `title` customizes terminal screen header.\n\nConsiderations: Length and character restrictions depend on device; keep alphanumeric to ensure compatibility. Provide client-side validation if a specific format is needed.\n\nSecurity: ApiKeyAuth or EphemeralAuth.\n\nErrors: Cancelled entry, timeout, unsupported character input.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "operationId": "prompt-input",
        "parameters": [],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"input\": \"G164\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "input": {
                      "type": "string",
                      "example": "G164"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "register": {
                    "type": "string",
                    "required": true,
                    "description": " The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register."
                  },
                  "title": {
                    "type": "string",
                    "description": "Title for this prompt, displayed on the top of the terminal screen. Defaults to '' (empty string)."
                  }
                },
                "required": [
                  "register"
                ]
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```