Parameters
No parameters required
This endpoint takes no path, query, header or body parameters.
TerminalpostBffTerminalSession
Response schema
1 status code documented
200Success
userobjectRequiredAuthenticated user info
idstringRequiredUser ID
namestringRequiredDisplay name of the user
rolestringRequiredUser role in the organisation
Examples
memberroottenantobjectRequiredCurrent organisation context
idstringRequiredOrganisation ID
namestringRequiredOrganisation name
cwdstringRequiredInitial working directory
Example
/drivewelcomeobjectRequiredStructured status payload rendered by the terminal welcome block
productstringRequiredProduct name shown as header title
Example
bizkithub terminalversionstringRequiredSemantic version string
Example
1.0.0channelstringRequiredSurface identifier for the terminal session
Example
webbuildstringRequired7-character commit short-hash (or "dev" outside deploys)
Example
4f2a91csessionStartedAtstringRequiredISO 8601 UTC timestamp of session start
sessionIdstringRequiredShort session identifier for support tickets
Example
sess_8ktz4memberEmailstringRequiredEmail of the authenticated member
Example
user@example.commemberRole"root" | "member"RequiredEffective role (root if member has the root permission, else member)
orgNamestringRequiredOrganisation display name
Example
GymRoomorgSlugstringRequiredOrganisation slug
Example
gymroomregionstringRequiredVercel deployment region or "local"
Examples
fra1localclientIpstringRequiredResolved client IP address
Example
94.112.57.122docsUrlstringRequiredAbsolute URL to the terminal documentation
Example
https://docs.bizkithub.com/terminalResponse example
application/json{
"user": {
"id": "example_id",
"name": "example_name",
"role": "member"
},
"tenant": {
"id": "example_id",
"name": "example_name"
},
"cwd": "/drive",
"welcome": {
"product": "bizkithub terminal",
"version": "1.0.0",
"channel": "web",
"build": "4f2a91c",
"sessionStartedAt": "example_sessionStartedAt",
"sessionId": "sess_8ktz4",
"memberEmail": "user@example.com",
"orgName": "GymRoom",
"orgSlug": "gymroom",
"region": "fra1",
"clientIp": "94.112.57.122",
"docsUrl": "https://docs.bizkithub.com/terminal"
}
}Request example
POST /bff/terminal/session
curl -X POST "https://api.bizkithub.com/bff/terminal/session" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Need an API key?
All BizKitHub public API endpoints require authentication via API key.