Prepare budgeted agent guidance for one turn

POST

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

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/custom-prompt/turn-guidance \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "userText": "example", "includeDbtRules": false, "dbtProjectId": "example" }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Request Body^required

Media typeapplication/json

object

userText

required

string

>= 1 characters <= 100000 characters

includeDbtRules

boolean

dbtProjectId

string

Responses

200

Prepared turn guidance.

Media typeapplication/json

object

success

required

boolean

skillsBlock

required

string

dbtRulesBlock

required

string

Example

{
  "success": true
}

400

Invalid request

Media typeapplication/json

object

success

boolean

error

required

string

Example

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

403

Access denied

Media typeapplication/json

object

success

boolean

error

required

string

Example

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

500

Failed to prepare guidance

Media typeapplication/json

object

success

boolean

error

required

string

Example

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