Skip to main content
POST
Classify Agent Blueprint
Read only Classify an agent blueprint to get a type recommendation from structured business and call requirements. This operation does not create or publish an agent.

Before you begin

  • Send a valid workspace API key.
  • Supply the blueprint fields you know. Each field is optional; text fields allow 4000 characters each, while language allows 120.

Classify Agent Blueprint Request

Verify the result

The current route returns HTTP 201 with data.shape, data.pipeline, data.confidence, data.evidence, data.needsTiebreak, and data.features. Shapes are spa, cfa, and ivr; pipelines are cascaded and s2s. Compare the evidence with the intended call before choosing a type.

Errors and recovery

400 means a field has the wrong type or exceeds its length limit. For 401, correct the API key. The service uses a rule-based recommendation if its model-assisted step fails. Recommendations can change between requests; retrying does not create duplicate agents.

Authorizations

Authorization
string
header
required

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

Body

application/json
company_and_offering
string
Maximum string length: 4000
target_customer
string
Maximum string length: 4000
primary_goal
string
Maximum string length: 4000
success_criteria
string
Maximum string length: 4000
information_to_collect
string
Maximum string length: 4000
objections_and_faqs
string
Maximum string length: 4000
agent_tone
string
Maximum string length: 4000
additional_context
string
Maximum string length: 4000
language
string
Maximum string length: 120

Response

Successful response.

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