Skip to main content
POST
Search recipes

Headers

X-API-Key
string | null

Body

application/json

Request payload for recipe knowledge-base search.

query
string
default:""

Natural language search query (optional)

source
enum<string>
default:knowledge

Search source (only 'knowledge' is supported)

Available options:
knowledge
limit
integer | null
default:1

Max results for knowledge search

chain
string | null

Filter recipes by chain symbol (e.g. 'ethereum', 'solana', 'bitcoin')

token
string | null

Filter recipes by token symbol (e.g. 'ETH', 'USDT', 'BTC')

keywords
string[] | null

List of keywords for filtering documents during keyword search

search_type
enum<string> | null
default:keyword

Search type: 'vector', 'keyword', or 'hybrid'

Available options:
vector,
keyword,
hybrid
wallet_id
string<uuid> | null

Wallet UUID. When provided, active pacts that reference each matched recipe are embedded as matching_pacts in each result item.

Response

Successful Response

result
RecipeSearchResponse · object
required

Unified search response envelope.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object | null

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.