API · Beta 0.1.1
API
Kaikki hakemistossa on saatavilla JSON-muodossa: väitteet lähteineen ja medioineen, levytykset, artistit, soittimet, haku sekä tapa ehdottaa uusia tietueita, jotka päätyvät samaan tarkistusjonoon kuin sivustolla. API on beta-vaiheessa. Versio 0.1.1. Kenttien nimet ja muodot voivat muuttua hakemiston vakiintuessa; muutokset luetellaan tämän sivun alalaidassa, ja OpenAPI-dokumentti on aina tarkka nykyinen sopimus.
Tokenin hankkiminen
- Luo tili ja kirjaudu sisään.
- Avaa API-tokenit kohdassa Omat ja luo yksi. Se näytetään kerran; se alkaa merkeillä
sd_. - Lähetä se bearer-tokenina jokaisessa pyynnössä.
curl -H "Authorization: Bearer sd_..." "https://synth.directory/api/v1/claims?q=juno&status=verified"
Rajat
200 pyyntöä tunnissa per token. Jokainen vastaus sisältää X-RateLimit-Limit- ja X-RateLimit-Remaining-otsikot; rajan ylittyessä saat 429-vastauksen ja JSON-viestin. Kumppaneille ja hakemiston omalle botille on rajoittamaton taso, kysy.
Lukeminen
Listat on sivutettu: page ja per_page (enintään 100), next_page mukana vastauksen rungossa.
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=· esiintyjät ja tuottajat ·GET /api/v1/people/{id}· sekä hyväksytyt osallistumistiedotGET /api/v1/search?q=· artistit, levytykset ja soittimet yhdessä vastauksessa
Tilat: verified, potentially, submitted, inferred (tietopankista, ei vielä lähdettä), disputed. Väiteri vi näyttää yhdeltä riviltä alla olevassa viennissä.
Presetit, arviot ja suosikit ovat vain sivuston käyttäjille. Niitä ei ole API:ssa eikä niitä koskaan viedä.
Ehdottaminen
POST /api/v1/propose asettaa ehdotuksen jonoon aivan kuten sivustokin tekee; henkilö tarkistaa sen ennen kuin mitään julkaistaan. Tokenin nimi tallennetaan ehdotukseen, joten botit näkyvät tarkistuksessa.
{"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"}
Roolit: väite played, programmed · levytys produced, engineered, mixed, arranged. Henkilö tunnistetaan nimen perusteella kirjainkoosta riippumatta tai luodaan uusi. Osallistumistiedot ovat faktoja, joten toisin kuin presetit, ne ovat mukana API:ssa ja viennissä.
Koko hakemisto
GET /export/manifest.json on julkinen ja kertoo, mitä siellä on. GET /export/claims.jsonl suoratoistaa jokaisen väitteen lähteineen ja hyväksyttyine medioineen, yksi JSON-objekti riviä kohden, since- ja status-suodattimilla. Se vaatii vientitokenin, kysy.
Lisenssi
Yksittäiset tosiasiat ovat CC0-lisenssillä. Hakemisto kokoelmana, ja jokainen merkittävä ote kuten vienti, on Open Database Licence -lisenssin alainen: mainitse hakemisto lähteenä ja jaa takaisin tietokanta, jonka johdat siitä. Kaupallinen lisenssi suljetuille tuotteille on saatavilla Box Of Rulesilta.
Sopimus
OpenAPI 3.1 -dokumentti · llms.txt · ai-catalog.json
Muutokset
- 0.1.1 (10. syyskuuta 2026) Henkilöt: esiintyjien ja tuottajien osallistumistiedot väitteissä ja levytyksissä, henkilöiden rajapinnat, osallistumisehdotukset.
- 0.1.0 (10. syyskuuta 2026) Ensimmäinen beta: tokenit, 200 tunnissa, väitteiden, levytysten, artistien, soittimien ja haun lukeminen; ehdotukset väitteille, lähteille, artisteille ja levytyksille; vientisyöte.