BizKitHub
DocsAPI ReferenceTerminal/bff/terminal/interact
postTerminalAdmin BFF

/bff/terminal/interact

Respond to interactive prompt

TerminalpostBffTerminalInteract

Parameters

JSON body

Request body

application/json
cwdstringOptional

Current working directory

Example/drive
commandIdstringRequired

ID of the command awaiting input

interactionIdstringRequired

ID of the specific prompt to answer

valueboolean | string | numberRequired

User-provided response value

One of 3:
Variant 1
boolean
Variant 2
string
Variant 3
number

Response schema

1 status code documented

200Success
commandIdstringRequired

Unique identifier of the executed command

outputsobject | object | object | object | object | object | object[]Required

List of output blocks produced by the command

Each array item:
object | object | object | object | object | object | object
One of 7:
Variant 1
type"text"Required

Output type discriminator

contentstringRequired

Text content of the output line

style"info" | "success" | "warning" | "error" | "muted"Required

Visual style applied to the text

Variant 2
type"table"Required

Output type discriminator

columnsstring[]Required

Column header names

rowsstring[][]Required

Table row data as string arrays

totalnumberRequired

Total number of rows before truncation

truncatednumberOptional

Number of rows omitted due to truncation

Variant 3
type"prompt"Required

Output type discriminator

interactionIdstringRequired

Unique ID for this interactive prompt

promptType"confirm" | "input" | "select" | "password"Required

Type of user input expected

messagestringRequired

Prompt message displayed to the user

defaultbooleanOptional

Default value for confirm prompts

optionsstring[]Optional

Available choices for select prompts

Variant 4
type"progress"Required

Output type discriminator

currentnumberRequired

Current progress value

totalnumberRequired

Total progress value

labelstringRequired

Progress bar label

Variant 5
type"file"Required

Output type discriminator

urlstringRequired

Download URL for the file

namestringRequired

File name

Examplereport.csv
sizenumberRequired

File size in bytes

Variant 6
type"json"Required

Output type discriminator

dataanyRequired

Arbitrary JSON payload

Variant 7
type"redirect"Required

Output type discriminator

urlstringRequired

Target URL to navigate to

labelstringRequired

Display label for the link

status"done" | "awaiting_input" | "running" | "cancelled"Required

Current execution status of the command

cwdstringRequired

Working directory after command execution

Example/drive
durationnumberRequired

Execution time in milliseconds

Response example

application/json
{
  "commandId": "example_commandId",
  "outputs": [],
  "cwd": "/drive",
  "duration": 0
}

Request example

POST /bff/terminal/interact

post
curl -X POST "https://api.bizkithub.com/bff/terminal/interact" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "cwd": "/drive",
  "commandId": "example_commandId",
  "interactionId": "example_interactionId"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key