Entwicklung · REST-API
Die versionierte API, /api/v1, ist der stabile Zugang: den Korpus mit 19.000+ Publikationen durchsuchen und durchblättern, eine Publikation abrufen, den Parameterkatalog auflisten – mit einem API-Schlüssel für ein eigenes Tageskontingent. Die fünf Endpunkte, auf denen die Website läuft – Vorhersage, vollständige Suche, Publikationsdatensätze, bayessche Priors und der Chat –, sind unten ebenfalls dokumentiert, jedoch ohne diese Stabilitätszusage. Korpuszahlen, Stand August 2026.
Jeder v1-Endpunkt funktioniert ohne Schlüssel, mit dem Minutenbudget Ihrer IP-Adresse. Mit einem Schlüssel zählen Aufrufe stattdessen gegen das eigene Tageskontingent Ihres Kontos.
Melden Sie sich an, öffnen Sie Ihr Profil und erstellen Sie unter API-Schlüssel einen Schlüssel. Der vollständige Schlüssel wird nur einmal angezeigt, beim Erstellen: Kopieren Sie ihn dann. MESSAI speichert nur einen Hash; ein verlorener Schlüssel lässt sich daher nicht wiederherstellen, nur ersetzen. Auf derselben Seite können Sie einen Schlüssel jederzeit widerrufen.
Profil öffnenIm Header X-API-Key oder als Authorization: Bearer. Ein widerrufener, abgelaufener oder falsch eingegebener Schlüssel erhält 401; er fällt nie auf anonymen Zugriff zurück.
X-API-Key: sk_free_… Authorization: Bearer sk_free_…
Jede Antwort enthält X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset (Sekunden, bis die nächste Anfrage verfügbar ist). Ist das Limit erreicht, antwortet die API mit 429 und Retry-After.
X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 997 X-RateLimit-Reset: 86
| Aufrufer | Budget | Gezählt pro |
|---|---|---|
| API-Schlüssel | 1.000 Anfragen pro Tag, laufend aufgefüllt (eine alle 86,4 s) | Konto: Alle seine Schlüssel teilen sich ein Kontingent |
| Ohne Schlüssel | 60 Anfragen pro Minute, in Schüben von bis zu 120 | IP-Adresse |
| Angemeldet auf www.messai.io | 300 Anfragen pro Minute, in Schüben von bis zu 600 | Konto |
Ein Lesezugriff zählt als eine Anfrage. Auf den Endpunkten der Website zählen aufwendigere Aufrufe mehr: POST /api/ml/predict 10, POST /api/chat 25, jeder andere Schreibzugriff 2. API-Schlüssel gelten nur für /api/v1.
Die Schlüsselverwaltung (GET und POST /api/v1/api-keys, DELETE /api/v1/api-keys/{id}) erfordert eine angemeldete Sitzung, keinen API-Schlüssel: Diese Aufrufe macht Ihre Profilseite.
/api/v1/papers Den Korpus per Text durchsuchen oder durchblättern, gefiltert nach Systemtyp und Erscheinungsjahr. Liefert eine Seite mit Publikationen samt Titel, Autorenangaben, Jahr, Zeitschrift, DOI, Systemtyp, Publikationstyp und Zitationszahl.
Parameter
Abfrageparameter: q string Volltextabfrage. Weglassen, um den Korpus durchzublättern. systemType string Einer der 17 primären Systemtypen (MFC, MEC, MES, MDC, …), ohne Beachtung der Groß-/Kleinschreibung. Publikationen, die der Klassifikator nicht zugeordnet hat, passen nie. yearStart integer Frühestes Erscheinungsjahr, einschließlich. yearEnd integer Spätestes Erscheinungsjahr, einschließlich. sort string relevance (mit q die beste Übereinstimmung zuerst), date (neueste zuerst) oder citations. Standard: relevance. page integer Ab 1. Standard: 1. limit integer 1–100. Standard: 20.
Beispiel
curl -H 'X-API-Key: sk_free_…' \
'https://www.messai.io/api/v1/papers?q=biochar+anode&systemType=MFC&yearStart=2020&limit=5' \
| jq '.data.papers[] | {id, title, year, citationCount}' Hinweise
/api/v1/papers/{id} Eine Publikation per ID: die Felder der Liste, dazu Kennungen (PubMed, arXiv), Schlagwörter, Anwendungsbereiche und die maschinell erzeugte Zusammenfassung.
Parameter
Pfadparameter: id string ID der Publikation, wie von GET /api/v1/papers geliefert.
Beispiel
curl -H 'X-API-Key: sk_free_…' 'https://www.messai.io/api/v1/papers/<id>' \
| jq '.data | {title, year, doi, systemType, aiSummary}' Hinweise
/api/v1/parameters Die Parameter, die MESSAI aus Publikationen extrahiert: Name, kanonischer Slug, Einheit, Kategorie und Beschreibung.
Parameter
Abfrageparameter: q string Gleicht Slug, Name oder Beschreibung ab. category string Eine der 18 Kategorien (PERFORMANCE, MATERIALS, …), ohne Beachtung der Groß-/Kleinschreibung. page integer Ab 1. Standard: 1. limit integer 1–100. Standard: 50.
Beispiel
curl -H 'X-API-Key: sk_free_…' \
'https://www.messai.io/api/v1/parameters?q=coulombic+efficiency' \
| jq '.data.parameters[] | {slug, name, unit, category}' Hinweise
Jede v1-Antwort ist JSON in einer einheitlichen Hülle. Verzweigen Sie nach error.code; error.message ist für Menschen geschrieben und kann sich ändern.
Erfolg
{
"data": { "papers": [ … ], "pagination": { … } },
"error": null
} Fehler
{
"data": null,
"error": {
"code": "rate_limited",
"message": "Rate limit reached (apiKey tier). Retry in 86 s."
}
} | error.code | HTTP | Bedeutung |
|---|---|---|
| invalid_request | 400 | Ein Parameter fehlt, ist fehlerhaft oder unbekannt; error.details listet die Probleme auf. |
| unauthorized | 401 | Nur Schlüsselverwaltung: keine angemeldete Sitzung. |
| invalid_api_key | 401 | Der Schlüssel wurde nicht von MESSAI ausgegeben. |
| api_key_revoked | 401 | Der Schlüssel wurde im Profil widerrufen. |
| api_key_expired | 401 | Der Schlüssel hat das beim Erstellen gewählte Ablaufdatum überschritten. |
| not_found | 404 | Keine sichtbare Publikation mit dieser ID (bei der Schlüsselverwaltung: kein Schlüssel von Ihnen). |
| key_limit_reached | 409 | Nur Schlüsselverwaltung: Das Konto hat bereits die Höchstzahl aktiver Schlüssel; widerrufen Sie zuerst einen. |
| rate_limited | 429 | Das Budget ist aufgebraucht; nach Retry-After Sekunden erneut versuchen. |
| internal_error | 500 | Bei uns ist etwas fehlgeschlagen; in Kürze erneut versuchen. |
| api_keys_unavailable | 503 | API-Schlüssel sind auf dieser Bereitstellung noch nicht aktiviert; ohne Schlüssel aufrufen. |
| rate_limiter_unavailable | 503 | Die Nutzungserfassung ist kurz nicht verfügbar; in Kürze erneut versuchen. |
| upstream_unavailable | 503 | Der Schlüssel konnte nicht geprüft werden; in Kürze erneut versuchen. |
/api/v2. v1 antwortet noch mindestens sechs Monate, nachdem v2 auf dieser Seite angekündigt wurde./api/openapi.json (OpenAPI 3.1), erzeugt aus der Validierung der Handler selbst.Auf diesen fünf läuft die MESSAI-Website, und sie ändern sich mit ihr; eine Stabilitätszusage gibt es nicht. Sie nehmen keinen API-Schlüssel entgegen: Aufrufe werden pro IP-Adresse gezählt oder, bei einer angemeldeten Browsersitzung, pro Konto.
/api/ml/predict Liefert Leistungsdichte, Stromdichte, Coulomb-Effizienz, Spannung und eine Anreicherungsantwort aus mehreren Blöcken für eine Reaktorkonfiguration. MFC läuft über die vollständige v1-Anreicherung; MEC/MES/MDC/MMRC/MBES/MNRC laufen über ihr jeweils eigenes klassenspezifisches Vorhersagemodell.
Anfragetext
{
"systemType": "MFC",
"materials": {
"anodeMaterial": "carbon-cloth",
"cathodeMaterial": "platinum-carbon",
"anodeSurfaceArea": 25,
"cathodeSurfaceArea": 25
},
"conditions": {
"temperature": 30,
"ph": 7,
"pressure": 1,
"substrateConcentration": 1000,
"externalResistance": 1000
},
"configuration": {
"reactorVolume": 250,
"electrodeSpacing": 2,
"numChambers": 1
}
} Beispiel
curl -X POST https://www.messai.io/api/ml/predict \ -H 'Content-Type: application/json' \ -d @request.json | jq '.powerOutput'
Hinweise
/api/research/search Die Suche hinter der Seite /research: Stichwort-, semantische oder hybride Suche in 19.000+ indexierten Publikationen, mit allen Filtern der Seite. GET /api/v1/papers ist die stabile Teilmenge.
Parameter
Abfrageparameter:
q string Volltextabfrage; leer blättert durch
searchType string keyword, semantic oder hybrid. Standard: hybrid
page integer Ab 0 gezählt. Standard: 0
limit integer Standard: 20, max. 100
filters JSON URL-kodiertes JSON: {"primarySystemType":["MFC"]}
sort JSON URL-kodiertes JSON: {"field":"citations","order":"desc"} Beispiel
curl -G https://www.messai.io/api/research/search \
--data-urlencode 'q=carbon felt' \
--data-urlencode 'filters={"primarySystemType":["MFC"]}' \
--data-urlencode 'limit=10' | jq '.data.papers[0:3]' Hinweise
/api/papers/{id} Liefert den gespeicherten ResearchPaper-Datensatz zur ID, einschließlich Autorenangaben, Zusammenfassung, DOI, Erscheinungsdatum und primarySystemType.
Parameter
Pfadparameter: id string ID der Publikation, wie von der Suche geliefert
Beispiel
curl 'https://www.messai.io/api/papers/<id>' \
| jq '.data | {title, authors, publicationDate, primarySystemType}' Hinweise
/api/parameters/{slug}/hierarchical-prior Liefert die hierarchische v1-Posterior-Anpassung (PyMC NUTS) für den Slug eines Parameters: gepooltes μ + 95-%-Intervall, Strata je system_type, MCMC-Diagnosewerte (R̂, ESS, Divergenzen).
Parameter
Pfadparameter: slug string Kanonischer Parameter-Slug (z. B. "power_density_areal")
Beispiel
curl 'https://www.messai.io/api/parameters/power_density_areal/hierarchical-prior' | jq '.pooled'
Hinweise
/api/chat LLM-Antworten streamen, gestützt auf ~50 Korpus- und ML-Werkzeuge. Alle Tatsachenaussagen müssen Publikationen zitieren, die über Tool-Aufrufe abgerufen wurden.
Anfragetext
{
"messages": [{"role": "user", "content": "What anode materials maximise power density for acetate substrates?"}],
"mode": "general"
} Beispiel
curl -N -X POST https://www.messai.io/api/chat \ -H 'Content-Type: application/json' \ -d @messages.json
Hinweise
MESSAI ist auch ein Model-Context-Protocol-Server (MCP). Verbinden Sie Ihren KI-Assistenten einmal und stellen Sie Forschungsfragen in natürlicher Sprache; er fragt Korpus, Priors und Vorhersagemodell direkt ab und nennt seine Quellen.
Server-URL
https://www.messai.io/api/mcp
Verwenden Sie den www-Host: Die Domain messai.io ohne www beantwortet MCP-Anfragen mit einer Weiterleitung, der manche Clients nicht folgen.
Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"messai": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://www.messai.io/api/mcp"
]
}
}
} Cursor und andere Clients mit Remote-MCP-Unterstützung
{
"mcpServers": {
"messai": {
"url": "https://www.messai.io/api/mcp"
}
}
} 15 schreibgeschützte Werkzeuge