Skip to main content
POST
Recommend Agent Type
Read only Recommend an agent type from a short description of the calls you want to handle. The response can suggest one type, a two-agent combination, or a clarifying question. It does not create or publish an agent.

Before you begin

  • Prepare a description of the caller, goal, and routing requirements.
  • Send a valid workspace API key. The description is required and limited to 2000 characters.

Recommend Agent Type Request

Verify the result

The current route returns HTTP 201 with the recommendation under data. Read why and check shape, agent_type, pipeline, combo, and clarify. If clarification is requested, include the answer in a revised description. If a combination is suggested, create and connect the agents separately.

Errors and recovery

400 means the description is missing, the wrong type, or too long. Correct the input. For 401, correct the API key. After 500, retry the recommendation. Repeating this operation does not duplicate an agent, but generated advice can differ.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
description
string
required
Required string length: 1 - 2000

Response

Successful response.

success
boolean
required
error
boolean
required
statusCode
integer
required
message
string
required
data
object
required
timestamp
string<date-time>
required