Stych API Documentation

import requests

response = requests.post(
    "https://api.conformal.io/v1/matching/",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "dataset1": [
            {"id": 1, "name": "Apple Inc", "address": "1 Apple Park Way"},
            {"id": 2, "name": "Microsoft Corp", "address": "One Microsoft Way"}
        ],
        "dataset2": [
            {"id": 1, "company_name": "Apple Inc.", "location": "Cupertino, CA"},
            {"id": 2, "company_name": "Microsoft Corporation", "location": "Redmond, WA"}
        ],
        "method": "similarity",
        "match_x__vs__y": ["name__vs__company_name", "address__vs__location"],
        "confidence_threshold": 0.8,
        "top_n": 3
    }
)
print(response.json())

const response = await fetch(
    "https://api.conformal.io/v1/matching/",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY",
            "Content-Type": "application/json"
        },
        body: JSON.stringify({
            dataset1: [
                {id: 1, name: "Apple Inc", address: "1 Apple Park Way"},
                {id: 2, name: "Microsoft Corp", address: "One Microsoft Way"}
            ],
            dataset2: [
                {id: 1, company_name: "Apple Inc.", location: "Cupertino, CA"},
                {id: 2, company_name: "Microsoft Corporation", location: "Redmond, WA"}
            ],
            method: "similarity",
            match_x__vs__y: ["name__vs__company_name", "address__vs__location"],
            confidence_threshold: 0.8,
            top_n: 3
        })
    }
);
const data = await response.json();

import requests

# Using requests with file upload
with open('customers.csv', 'rb') as f1, open('companies.csv', 'rb') as f2:
    files = {
        'dataset1_file': f1,
        'dataset2_file': f2
    }
    data = {
        'method': 'similarity',
        'match_x__vs__y': '["name__vs__company_name"]',
        'top_n': '3'
    }
    response = requests.post(
        "https://api.conformal.io/v1/matching/upload",
        headers={"x-api-key": "YOUR_API_KEY"},
        files=files,
        data=data
    )
    print(response.json())

// Using FormData for file upload
const formData = new FormData();
formData.append('dataset1_file', fileInput1.files[0]);
formData.append('dataset2_file', fileInput2.files[0]);
formData.append('method', 'similarity');
formData.append('match_x__vs__y', '["name__vs__company_name"]');
formData.append('top_n', '3');

const response = await fetch(
    "https://api.conformal.io/v1/matching/upload",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        },
        body: formData
    }
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.conformal.io/v1/jobs/",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "dataset1": [
            {"id": 1, "name": "Apple Inc", "address": "1 Apple Park Way"},
            {"id": 2, "name": "Microsoft Corp", "address": "One Microsoft Way"}
        ],
        "dataset2": [
            {"id": 1, "company_name": "Apple Inc.", "location": "Cupertino, CA"},
            {"id": 2, "company_name": "Microsoft Corporation", "location": "Redmond, WA"}
        ],
        "method": "similarity",
        "match_x__vs__y": ["name__vs__company_name", "address__vs__location"],
        "top_n": 3,
        "enable_auditing": True,
        "audit_models": ["qwen/qwen3-32b"]
    }
)
print(response.json())

const response = await fetch(
    "https://api.conformal.io/v1/jobs/",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY",
            "Content-Type": "application/json"
        },
        body: JSON.stringify({
            dataset1: [
                {id: 1, name: "Apple Inc", address: "1 Apple Park Way"},
                {id: 2, name: "Microsoft Corp", address: "One Microsoft Way"}
            ],
            dataset2: [
                {id: 1, company_name: "Apple Inc.", location: "Cupertino, CA"},
                {id: 2, company_name: "Microsoft Corporation", location: "Redmond, WA"}
            ],
            method: "similarity",
            match_x__vs__y: ["name__vs__company_name", "address__vs__location"],
            top_n: 3,
            enable_auditing: true,
            audit_models: ["qwen/qwen3-32b"]
        })
    }
);
const data = await response.json();

import requests

# Using requests with file upload
with open('customers.csv', 'rb') as f1, open('companies.csv', 'rb') as f2:
    files = {
        'dataset1_file': f1,
        'dataset2_file': f2
    }
    data = {
        'method': 'similarity',
        'match_x__vs__y': '["name__vs__company_name"]',
        'top_n': '3',
        'enable_auditing': 'true',
        'audit_models': '["qwen/qwen3-32b"]'
    }
    response = requests.post(
        "https://api.conformal.io/v1/jobs/upload",
        headers={"x-api-key": "YOUR_API_KEY"},
        files=files,
        data=data
    )
    print(response.json())

// Using FormData for file upload
const formData = new FormData();
formData.append('dataset1_file', fileInput1.files[0]);
formData.append('dataset2_file', fileInput2.files[0]);
formData.append('method', 'similarity');
formData.append('match_x__vs__y', '["name__vs__company_name"]');
formData.append('top_n', '3');
formData.append('enable_auditing', 'true');
formData.append('audit_models', '["qwen/qwen3-32b"]');

const response = await fetch(
    "https://api.conformal.io/v1/jobs/upload",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        },
        body: formData
    }
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789",
    headers={"x-api-key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789",
    {
        method: "GET",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        }
    }
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789/cancel",
    headers={"x-api-key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789/cancel",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        }
    }
);
const data = await response.json();

import requests

response = requests.delete(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789",
    headers={"x-api-key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
    "https://api.conformal.io/v1/jobs/abc123-def456-ghi789",
    {
        method: "DELETE",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        }
    }
);
const data = await response.json();

import requests

# Analyze datasets to identify similar columns
response = requests.post(
    "https://api.conformal.io/v1/analyze_data/",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "question": "What columns are similar in these two datasets?",
        "dataset1_path": "s3://bucket/products.csv",
        "dataset2_path": "s3://bucket/inventory.csv"
    }
)

result = response.json()
print(result["answer"])  # Conversational answer
print(result["detected_matches"])  # Detected column pairs

# Or with file upload
with open('products.csv', 'rb') as f1, open('inventory.csv', 'rb') as f2:
    files = {
        'dataset1_file': f1,
        'dataset2_file': f2
    }
    data = {
        'question': 'What columns are similar?'
    }
    response = requests.post(
        "https://api.conformal.io/v1/analyze_data/",
        headers={"x-api-key": "YOUR_API_KEY"},
        files=files,
        data=data
    )
    print(response.json())

// Analyze datasets to identify similar columns
const response = await fetch(
    "https://api.conformal.io/v1/analyze_data/",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY",
            "Content-Type": "application/json"
        },
        body: JSON.stringify({
            question: "What columns are similar in these two datasets?",
            dataset1_path: "s3://bucket/products.csv",
            dataset2_path: "s3://bucket/inventory.csv"
        })
    }
);
const result = await response.json();
console.log(result.answer);  // Conversational answer
console.log(result.detected_matches);  // Detected column pairs

// Or with file upload
const formData = new FormData();
formData.append('question', 'What columns are similar?');
formData.append('dataset1_file', fileInput1.files[0]);
formData.append('dataset2_file', fileInput2.files[0]);

const uploadResponse = await fetch(
    "https://api.conformal.io/v1/analyze_data/",
    {
        method: "POST",
        headers: {
            "x-api-key": "YOUR_API_KEY"
        },
        body: formData
    }
);
const uploadResult = await uploadResponse.json();