Skip to content

Get the workspace custom prompt

GET
/api/workspaces/{workspaceId}/custom-prompt

Returns the workspace’s custom agent prompt, falling back to the default template when unset.

workspaceId
required
string

Custom prompt content.

object
success
required
boolean
content
required
string

Invalid workspace ID

object
success
boolean
error
required
string
Example
Human-readable error message

Workspace not found

object
success
boolean
error
required
string
Example
Human-readable error message

Failed to read custom prompt

object
success
boolean
error
required
string
Example
Human-readable error message