Get the workspace custom prompt

GET

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

const url = 'http://localhost:8080/api/workspaces/example/custom-prompt';
const options = {method: 'GET', headers: {cookie: 'auth_session=<auth_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/workspaces/example/custom-prompt \
  --cookie auth_session=<auth_session>

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

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Responses

200

Custom prompt content.

application/json

object

success

required

boolean

content

required

string

selfDirective

string

Example

{
  "success": true
}

400

Invalid workspace ID

application/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

404

Workspace not found

application/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

500

Failed to read custom prompt

application/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}