Skip to main content
POST
/
agent-setup
/
agent-context
/
feedback
Submit feedback on the provided context
curl --request POST \
  --url https://api.beamstudio.ai/agent-setup/agent-context/feedback \
  --header 'Content-Type: application/json' \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "I want to create an agent for invoice reconciliation",
  "threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c"
}
'
{
  "threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c",
  "response": {
    "name": "Customer Support Agent",
    "description": "An AI agent that handles customer inquiries and provides support.",
    "agentWelcomeMessage": "Hello! I am your customer support assistant. How can I help you today?",
    "agentSetupMessage": "This agent is configured to handle billing inquiries and technical support.",
    "agentPersonality": "Friendly, professional, and helpful with a focus on resolving issues quickly.",
    "agentCategory": {
      "id": "<string>",
      "title": "<string>"
    },
    "themeIconUrl": "https://example.com/icons/support-agent.png"
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

​
current-workspace-id
string
required

Body

application/json
​
query
string
required

Feedback text or query about the agent setup. Use this to provide context, suggestions, or describe what kind of agent you want to create.

Example:

"I want to create an agent for invoice reconciliation"

​
threadId
string<uuid>
required

UUID of the conversation thread to continue. This maintains context across multiple feedback requests.

Example:

"1a2036c0-d533-4636-8f51-2a811763ef5c"

Response

201 - application/json
​
threadId
string<uuid>
required

UUID of the conversation thread. Use this threadId in subsequent requests to maintain context across the agent setup process.

Example:

"1a2036c0-d533-4636-8f51-2a811763ef5c"

​
response
object

Generated agent suggestions including name, description, welcome message, setup message, personality, and category based on the provided query.