Skip to main content
POST
/
api
/
v1
/
tap
/
generate
Generate tap script (AI)
curl --request POST \
  --url http://localhost:8080/api/v1/tap/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>",
  "tapName": "<string>",
  "oldScriptPath": "<string>",
  "secretName": "<string>",
  "tapType": "structured"
}
'
{
  "script": "<string>",
  "packages": [
    "<string>"
  ],
  "scriptPath": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Body

application/json
​
description
string
required
​
tapName
string
required
​
oldScriptPath
string

Path of a previous script to delete after the new one is written

​
secretName
string

Tap secret name — env var keys are passed to the AI as context

​
tapType
enum<string>
default:structured

Selects the system prompt for the generated script.

Available options:
structured,
document

Response

200 - application/json

Generated script

​
script
string
​
packages
string[]
​
scriptPath
string