ARarcadeai
Tools

Select Tools

Changed on

Selects the tools best suited to each of the given tasks, returning per-task suggestions with their input schemas. Pass the returned query_id to Execute Tool so the execution is correlated with the selection that surfaced the tool.

post/v1/tools/select

Request

  • Base URL
    https://api.arcade.dev
  • Auth
    API key in header Authorization

Request body

categoriesstring[]

Categories filters candidates to tools in any of these categories.

contextstring

Context is optional supplementary text (e.g. conversation history) sent to Condex via its dedicated context field. Condex keeps it out of the BM25 text leg; it informs the rerank stage (and embeddings only when Condex runs with SELECT_INCLUDE_EMBED_CONTEXT=true).

gateway_idstring

GatewayID scopes selection to a specific gateway's tool allow list. When empty, the caller's full CATE-allowed tool universe is considered.

include_staticboolean

IncludeStatic controls whether STATIC (builtin / statically configured) tools appear as candidates. Defaults to true when omitted.

tagsstring[]

Tags filters candidates to tools tagged with any of these labels.

tasksstring[] required

Tasks is the list of task descriptions to select tools for. Each task is sent to Condex individually and produces its own TaskSelectionResult. Must contain at least one entry, and no entry may be blank.

top_kinteger

TopK is the maximum number of suggestions to return per task. Absent applies the default of 5 and is capped at 20; a present value must be positive.

user_idstring

The user to select tools as. Required only when calling with an API key.

Response

OK

query_idstring

QueryID is the Condex-assigned identifier for this selection query. Taken from the first non-empty QueryID returned across tasks.

Changes