Skip to main content
GET
Retrieves details of an existing agent
Ruft die verfügbaren aktuellen Einstellungen und Details eines vorhandenen Agenten in deinem Workspace ab. Der Endpoint gibt die aktive (veröffentlichte) Version des Agenten zurück. Wenn der Agent noch nie veröffentlicht wurde, wird stattdessen der aktuelle Entwurf zurückgegeben.

Bevor du startest

  • API-Key-Scope: Erfordert einen API-Schlüssel mit dem Agenten API-Scope und Zugriff auf den Agenten, den du abrufen möchtest.
  • Veraltete Assistants API: Dies ist die neue Agents API mit nativer Vercel AI SDK Kompatibilität. Wenn du die veraltete Assistants API verwendest, siehe den Migrations-Guide.

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Parameter

Beispiele

Einfacher Abruf

Validierungsregeln

Die API wendet folgende Validierungsregeln an:
  • Agent-Zugriff - Dein API-Schlüssel muss Zugriff auf den Agenten haben
  • Workspace-Übereinstimmung - Der Agent muss zum selben Workspace wie dein API-Schlüssel gehören

Antwortformat

agent.access ist nur enthalten, wenn der API-Schlüssel eine direkte Editor- oder Besitzerfreigabe für den Agenten hat. Es listet direkte Benutzer-, Gruppen- und Workspace-Freigaben auf, ohne Besitzer- und API-Schlüssel-Freigaben. sharingManagedByAdmin ist schreibgeschützt; bei true können Freigaben über diese API nicht geändert werden. Die Freigabeeinstellungen sind aktuell und unabhängig von der zurückgegebenen Agentenversion.

Erfolgreiche Antwort (200 OK)

Das actions Array lässt IDs weg, deren Action fehlt oder gelöscht ist. Live-Actions, die in deinem Workspace nicht verfügbar sind, bleiben in der Liste. skillIds listet angehängte Skills. Dateivorlagen bleiben am Agenten und erscheinen in diesem Array nicht.

Fehlerbehandlung

Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Abfrageparameter

agentId
string<uuid>
erforderlich

Antwort

200 - application/json

Agent retrieved successfully

status
string
erforderlich
agent
object
erforderlich