Skip to content
Nexa Platform Docs

Suggest Tools Endpoint

POST
/api/automations/suggest-tools
curl --request POST \
  --url https://example.com/api/automations/suggest-tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "name": "example", "type": "example", "data_type": "example", "format_pattern": [ "example" ], "resolution_mode": "example", "source_column_prompt": "example", "aggregation_type": "example", "is_active": true, "chart_config": "example", "chart_aggregation": "example", "ai_prompt": "example", "ai_data_tags": "example" } ]'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Request
Array<object>
TagInput
object
name
required
Name
string
type
required
Type
string
data_type
required
Data Type
string
format_pattern
Any of:
Array<string>
resolution_mode
Any of:
string
source_column_prompt
Any of:
string
aggregation_type
Any of:
string
is_active
Is Active
boolean
default: true
chart_config
Any of:
Chart Config
chart_aggregation
Any of:
Chart Aggregation
ai_prompt
Any of:
Ai Prompt
ai_data_tags
Any of:
Ai Data Tags

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SuggestToolsResponse
object
success
required
Success
boolean
tag_tools
required
Tag Tools
Array<object>
TagToolMapping
object
tag_name
required
Tag Name
string
suggested_tools
Suggested Tools
Array<object>
default:
ToolSuggestion
object
tool_type
required
Tool Type
string
tool_id
required
Tool Id
string
tool_name
required
Tool Name
string
reason
required
Reason
string
genie_spaces_found
required
Genie Spaces Found
integer
vector_search_indexes_found
required
Vector Search Indexes Found
integer
tokens_used
required
Tokens Used
integer
Example
{
  "tag_tools": [
    {
      "suggested_tools": []
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}