API Quickstart

Use this guide to make your first request to the Tungaloy Catalog Search API.

Which Endpoint Should I Use?

For most users, start with POST /v1/catalog/smart-search.

Authentication

Send your API key as a Bearer token.

Code
Authorization: Bearer YOUR_API_KEY

First Request

Code
curl --request POST \
  --url https://e-catalog-search-main-ae100fb.d2.zuplo.dev/v1/catalog/smart-search \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"query":"Find 1 mm end mills","limit":10,"language":"en"}'

What You Get Back

The response contains the original query, the catalog-search result, and workflow identifiers.

Code
{
  "query": "Find 1 mm end mills",
  "result": "Found matching milling tools with 1 mm cutter diameter. Examples include EPD05R100U0100W05, ELD05R100U0100W03, and TECA010H3-04C06CF-R.05.",
  "workflow_run_id": "workflow-run-id",
  "task_id": "task-id"
}

When To Use Structured Search

Use POST /v1/catalog/search when you need raw fields for follow-up logic:

• resultCount
• returnedCount
• hasMore
• nextOffset
• columnDefinitions
• nextSuggestedFilters

Structured search is also better when your application already knows the exact fields and filters to apply.