Synth.Directory

API · بیٹا 0.1.1

API

ڈائریکٹری میں موجود ہر چیز JSON کے طور پر دستیاب ہے: دعوے ان کے ماخذ اور میڈیا کے ساتھ، ریکارڈز، فنکار، ساز، تلاش، اور نئی اندراجات تجویز کرنے کا ایک طریقہ جو ویب سائٹ کی طرح اسی جائزہ قطار میں پہنچتا ہے۔ API بیٹا میں ہے۔ ورژن 0.1.1۔ فیلڈ کے نام اور شکلیں ڈائریکٹری کے مستحکم ہونے کے ساتھ تبدیل ہو سکتی ہیں؛ تبدیلیاں اس صفحے کے نیچے درج ہیں، اور OpenAPI دستاویز ہمیشہ عین موجودہ معاہدہ ہے۔

ٹوکن حاصل کرنا

  1. اکاؤنٹ بنائیں اور لاگ ان کریں۔
  2. کھولیں API ٹوکنز میرے کے تحت جا کر ایک بنائیں۔ یہ ایک بار دکھایا جاتا ہے؛ یہ اس سے شروع ہوتا ہے sd_.
  3. اسے ہر درخواست کے ساتھ بیئرر ٹوکن کے طور پر بھیجیں۔
curl -H "Authorization: Bearer sd_..." "https://synth.directory/api/v1/claims?q=juno&status=verified"

حدود

فی ٹوکن فی گھنٹہ 200 درخواستیں۔ ہر جواب میں X-RateLimit-Limit اور X-RateLimit-Remaining شامل ہوتے ہیں؛ حد سے تجاوز پر آپ کو JSON پیغام کے ساتھ 429 ملتا ہے۔ شراکت داروں اور ڈائریکٹری کے اپنے بوٹ کے لیے ایک لامحدود درجہ موجود ہے؛ پوچھیں۔

پڑھا جا رہا ہے

فہرستیں صفحہ وار ہیں: page اور per_page (100 تک)، اور next_page باڈی میں۔

  • GET /api/v1/claims · q, status, origin, artist, instrument, role, since, order · GET /api/v1/claims/{id}
  • GET /api/v1/records · q, artist_id, status=wanted|claimed, since, order, with=claims · GET /api/v1/records/{id}
  • GET /api/v1/artists?q= · GET /api/v1/artists/{id}
  • GET /api/v1/instruments · q, maker, kind · GET /api/v1/instruments/{id}
  • GET /api/v1/people?q= · پرفارمرز اور پروڈیوسرز · GET /api/v1/people/{id} · ان کے منظور شدہ کریڈٹس کے ساتھ
  • GET /api/v1/search?q= · ایک جواب میں فنکار، ریکارڈز اور ساز

حیثیتیں: verified, potentially, submitted, inferred (علمی بنیاد سے، ابھی تک بلا ماخذ), disputed. دعوے کی قطار ذیل کی ایکسپورٹ کی ایک سطر جیسی نظر آتی ہے۔

پری سیٹس، درجہ بندیاں اور پسندیدہ صرف ویب سائٹ پر موجود لوگوں کے لیے ہیں۔ یہ API میں نہیں ہیں اور کبھی ایکسپورٹ نہیں ہوں گی۔

تجویز کیا جا رہا ہے

POST /api/v1/propose بالکل ویب سائٹ کی طرح تجویز کو قطار میں ڈالتا ہے؛ کوئی شخص اسے شائع ہونے سے پہلے جائزہ لیتا ہے۔ ٹوکن کا نام تجویز پر درج ہوتا ہے تاکہ جائزے میں بوٹس نظر آئیں۔

{"kind": "claim", "work_id": 101, "instrument": "Minimoog", "instrument_maker": "Moog", "role": "lead",
 "source": {"grade": "A", "kind": "interview", "url": "https://...", "publication": "Sound On Sound",
            "author": "...", "published_on": "1983-06-01", "quote": "one sentence, verbatim"}}
{"kind": "source", "claim_id": 202, "source": {...}}
{"kind": "artist", "name": "Tool", "country": "US", "refs": ["https://en.wikipedia.org/...", "https://musicbrainz.org/..."]}
{"kind": "record", "artist_id": 12, "title": "Lateralus", "year": 2001, "refs": ["https://musicbrainz.org/..."]}
{"kind": "credit", "subject": "claim", "id": 202, "person": "Vince Clarke", "part": "played", "note": "on the intro only"}
{"kind": "credit", "subject": "work", "id": 101, "person": "Flood", "part": "produced"}

کریڈٹ کے حصے: دعویٰ played, programmed · ریکارڈ produced, engineered, mixed, arranged. ایک شخص کو نام سے، حروف کیس سے قطع نظر، میچ کیا جاتا ہے، یا نیا بنایا جاتا ہے۔ کریڈٹس حقائق ہیں، اس لیے پری سیٹس کے برعکس یہ API اور ایکسپورٹ میں شامل ہیں۔

پوری ڈائریکٹری

GET /export/manifest.json عوامی ہے اور بتاتا ہے کہ وہاں کیا موجود ہے۔ GET /export/claims.jsonl ہر دعوے کو اس کے ماخذ اور منظور شدہ میڈیا کے ساتھ اسٹریم کرتا ہے، ہر سطر میں ایک JSON آبجیکٹ، since اور status فلٹرز کے ساتھ۔ اسے ایکسپورٹ ٹوکن درکار ہے؛ پوچھیں۔

لائسنس

انفرادی حقائق CC0 کے تحت ہیں۔ مجموعے کے طور پر ڈائریکٹری، اور کوئی بھی خاصا اقتباس جیسے ایکسپورٹ، اوپن ڈیٹا بیس لائسنس کے تحت ہے: ڈائریکٹری کو کریڈٹ دیں، اور اس سے اخذ کردہ ڈیٹا بیس واپس شیئر کریں۔ بند مصنوعات کے لیے تجارتی لائسنس Box Of Rules سے دستیاب ہے۔

معاہدہ

OpenAPI 3.1 دستاویز · llms.txt · ai-catalog.json

تبدیلیاں

  • 0.1.1 (10 ستمبر 2026) لوگ: دعووں اور ریکارڈز پر پرفارمر اور پروڈیوسر کریڈٹس، لوگوں کے اینڈ پوائنٹس، کریڈٹ کی تجاویز۔
  • 0.1.0 (10 ستمبر 2026) پہلا بیٹا: ٹوکنز، فی گھنٹہ 200، دعوے، ریکارڈز، فنکار، ساز اور تلاش پڑھنا؛ دعووں، ماخذ، فنکاروں اور ریکارڈز کی تجاویز؛ ایکسپورٹ فیڈ۔