Snyf API Reference

Welcome to the Snyf API. Upload your product catalog using the Upload API, and query it using natural language with the Search API.

Authentication

Include your API key in the header of every request.

x-api-key: sk-snyf-xxxxxxxxxxxxxxxxxxxx

POST

Upload Product

Add products to your catalog. Note: Returns 202 Accepted immediately; indexing is async.

https://ag42w9a4xj.execute-api.us-east-1.amazonaws.com/beta

Body Parameters

Field	Type	Description
company_id	string	ReqUnique company identifier.
product_id	string	ReqUnique product ID.
image_urls	array	ReqList of public image URLs.
title	string	Name of the product.
description	string	Detailed product description (improves search).

curl -X POST https://ag42w9a4xj.execute-api.us-east-1.amazonaws.com/beta \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "company_id": "your-company",
    "product_id": "p-001",
    "title": "Blue Denim Jacket",
    "description": "Vintage wash denim jacket with button closure",
    "image_urls": ["https://site.com/img.jpg"]
  }'

import requests
url = "https://ag42w9a4xj.execute-api.us-east-1.amazonaws.com/beta"
payload = {
    "company_id": "your-company",
    "product_id": "p-001",
    "title": "Blue Denim Jacket",
    "description": "Vintage wash denim jacket with button closure",
    "image_urls": ["https://site.com/img.jpg"]
}
requests.post(url, json=payload, headers={"x-api-key": "YOUR_KEY"})

const url = "https://ag42w9a4xj.execute-api.us-east-1.amazonaws.com/beta";
await fetch(url, {
  method: "POST",
  headers: { "x-api-key": "YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    company_id: "your-company",
    product_id: "p-001",
    title: "Blue Denim Jacket",
    description: "Vintage wash denim jacket with button closure",
    image_urls: ["https://site.com/img.jpg"]
  })
});

// Java 11+ HttpClient
String json = "{"
    + "\"company_id\":\"your-co\","
    + "\"product_id\":\"p1\","
    + "\"title\":\"Jacket\","
    + "\"description\":\"Vintage wash\","
    + "\"image_urls\":[\"http://img.com\"]"
    + "}";

HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://ag42w9a4xj.execute-api.us-east-1.amazonaws.com/beta"))
    .header("x-api-key", "YOUR_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build();
HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());

GET

Search Catalog

https://xf8vvtzpak.execute-api.us-east-1.amazonaws.com/searchtest2/search

Query Parameters

Param	Type	Description
query	string	ReqSearch text.
company_id	string	ReqMust match upload ID.
page	int	Page number (Def: 1).

curl -X GET "https://xf8vvtzpak.execute-api.us-east-1.amazonaws.com/searchtest2/search?query=dress&company_id=test-id" \
  -H "x-api-key: YOUR_KEY"

import requests
url = "https://xf8vvtzpak.execute-api.us-east-1.amazonaws.com/searchtest2/search"
params = {"query": "dress", "company_id": "test-id"}
requests.get(url, params=params, headers={"x-api-key": "YOUR_KEY"})

const url = new URL("https://xf8vvtzpak.execute-api.us-east-1.amazonaws.com/searchtest2/search");
url.search = new URLSearchParams({ query: "dress", company_id: "test-id" });
await fetch(url, { headers: { "x-api-key": "YOUR_KEY" } });

String url = "https://xf8vvtzpak.execute-api.us-east-1.amazonaws.com/searchtest2/search?query=dress&company_id=test-id";
HttpRequest req = HttpRequest.newBuilder().uri(URI.create(url))
    .header("x-api-key", "YOUR_KEY").GET().build();
HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());

Need help?

support@snyf.io