Terminal

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

POST

Create terminal ai

Stream a terminal model response through PostHog AI. Requires organization approval for AI data processing. SDK consumers must use getTerminalAiCreateUrl() with streaming fetch. The generated JSON client buffers the response and cannot parse SSE.

Required API key scopes

conversation:write

Query parameters

format
string
One of: "json""txt"

Request parameters

model
messages
array
max_tokens
integer
stream
boolean
Default: true
system
tools
array
temperature

Example request

POST /api/projects/:project_id/terminal_ai
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/terminal_ai/\
	-d model=undefined,\
	-d messages="array",\
	-d max_tokens="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/terminal_ai/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"messages": "array",
		"max_tokens": "integer"
	}
).json()