Snyf API Reference

curl -sS -X POST "$API_URL/collections/coll_ss25/upload" \
  -H "x-api-key: $API_KEY" \
  -F "csv_file=@catalog.csv" \
  -F "attribute_list_id=fashion-v1"

import os
import requests

API_URL = os.environ["API_URL"]
API_KEY = os.environ["API_KEY"]
COLLECTION_ID = os.environ["COLLECTION_ID"]

with open("catalog.csv", "rb") as catalog:
    response = requests.post(
        f"{API_URL}/collections/{COLLECTION_ID}/upload",
        headers={"x-api-key": API_KEY},
        files={"csv_file": catalog},
        data={"attribute_list_id": "fashion-v1"},
        timeout=30,
    )

response.raise_for_status()
print(response.json())

const API_URL = "https://xydj4rm9eg.execute-api.us-east-1.amazonaws.com";
const API_KEY = "YOUR_API_KEY";
const COLLECTION_ID = "coll_ss25";

async function uploadCatalog(file) {
  const formData = new FormData();
  formData.append("csv_file", file);
  formData.append("attribute_list_id", "fashion-v1");

  const response = await fetch(`${API_URL}/collections/${COLLECTION_ID}/upload`, {
    method: "POST",
    headers: { "x-api-key": API_KEY },
    body: formData
  });

  if (!response.ok) {
    throw new Error(`Upload failed: ${response.status}`);
  }

  return response.json();
}

type UploadResponse = {
  job_id: string;
  accepted_rows: number;
  rejected_rows: number;
  status: string;
};

const API_URL = "https://xydj4rm9eg.execute-api.us-east-1.amazonaws.com";
const API_KEY = "YOUR_API_KEY";
const COLLECTION_ID = "coll_ss25";

export async function uploadCatalog(file: File): Promise<UploadResponse> {
  const formData = new FormData();
  formData.append("csv_file", file);
  formData.append("attribute_list_id", "fashion-v1");

  const response = await fetch(`${API_URL}/collections/${COLLECTION_ID}/upload`, {
    method: "POST",
    headers: { "x-api-key": API_KEY },
    body: formData
  });

  if (!response.ok) {
    throw new Error(`Upload failed: ${response.status}`);
  }

  return response.json() as Promise<UploadResponse>;
}

package main

import (
	"bytes"
	"fmt"
	"io"
	"mime/multipart"
	"net/http"
	"os"
)

func main() {
	apiURL := os.Getenv("API_URL")
	apiKey := os.Getenv("API_KEY")
	collectionID := os.Getenv("COLLECTION_ID")

	var body bytes.Buffer
	writer := multipart.NewWriter(&body)

	file, err := os.Open("catalog.csv")
	if err != nil {
		panic(err)
	}
	defer file.Close()

	part, err := writer.CreateFormFile("csv_file", "catalog.csv")
	if err != nil {
		panic(err)
	}
	if _, err := io.Copy(part, file); err != nil {
		panic(err)
	}

	writer.WriteField("attribute_list_id", "fashion-v1")
	writer.Close()

	req, err := http.NewRequest("POST", apiURL+"/collections/"+collectionID+"/upload", &body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", apiKey)
	req.Header.Set("Content-Type", writer.FormDataContentType())

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		panic(fmt.Sprintf("upload failed: %s", resp.Status))
	}

	fmt.Println(resp.Status)
}

curl -sS -X POST "$API_URL/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $API_KEY" \
  -d '{
    "collection_id": "coll_ss25",
    "query": "flowy beach wedding look",
    "top_k": 5
  }'

import os
import requests

API_URL = os.environ["API_URL"]
API_KEY = os.environ["API_KEY"]

response = requests.post(
    f"{API_URL}/search",
    headers={"Content-Type": "application/json", "x-api-key": API_KEY},
    json={
        "collection_id": "coll_ss25",
        "query": "flowy beach wedding look",
        "top_k": 5,
    },
    timeout=30,
)

response.raise_for_status()
print(response.json())

const API_URL = "https://xydj4rm9eg.execute-api.us-east-1.amazonaws.com";
const API_KEY = "YOUR_API_KEY";

async function searchProducts(query) {
  const response = await fetch(`${API_URL}/search`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": API_KEY
    },
    body: JSON.stringify({
      collection_id: "coll_ss25",
      query,
      top_k: 5
    })
  });

  if (!response.ok) {
    throw new Error(`Search failed: ${response.status}`);
  }

  return response.json();
}

searchProducts("flowy beach wedding look").then(console.log);

type SearchResult = {
  product_id: string;
  name: string;
  image_urls: string[];
  score: number;
};

type SearchResponse = {
  collection_id: string;
  query: string;
  results: SearchResult[];
};

const API_URL = "https://xydj4rm9eg.execute-api.us-east-1.amazonaws.com";
const API_KEY = "YOUR_API_KEY";

export async function searchProducts(query: string, topK = 5): Promise<SearchResponse> {
  const response = await fetch(`${API_URL}/search`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": API_KEY
    },
    body: JSON.stringify({
      collection_id: "coll_ss25",
      query,
      top_k: topK
    })
  });

  if (!response.ok) {
    throw new Error(`Search failed: ${response.status}`);
  }

  return response.json() as Promise<SearchResponse>;
}

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	apiURL := os.Getenv("API_URL")
	apiKey := os.Getenv("API_KEY")

	body, _ := json.Marshal(map[string]any{
		"collection_id": "coll_ss25",
		"query":         "flowy beach wedding look",
		"top_k":         5,
	})

	req, err := http.NewRequest("POST", apiURL+"/search", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", apiKey)

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		panic(fmt.Sprintf("search failed: %s", resp.Status))
	}

	var result map[string]any
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		panic(err)
	}

	fmt.Printf("%+v\n", result)
}