Detect vertical for a tenant

POST

/api/v1/specialization/detect

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/specialization/detect \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "tenant_id": "example" }'

• Production
• Local development

Classify a tenant’s BusinessProfile into a vertical.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

DetectVerticalRequest

Request body for POST /detect.

object

tenant_id

required

Tenant Id

Tenant whose profile to classify

string

Example^generated

{
  "tenant_id": "example"
}

Responses

200

Successful Response

Media typeapplication/json

VerticalDetectionResult

Result of classifying a BusinessProfile into a vertical.

object

confidence

required

Confidence

number

<= 1

method

required

Method

string

Allowed values: keyword llm

requires_confirmation

required

Requires Confirmation

boolean

vertical_slug

required

Vertical Slug

string

Example

{
  "method": "keyword"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}