version auf draft, um den bearbeitbaren Entwurf zu lesen.
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
Parameter
Beispiele
Einfacher Abruf
Validierungsregeln
Die API wendet folgende Validierungsregeln an:- Agent-Zugriff - Dein API-Schlüssel muss Zugriff auf den Agenten haben
- Entwurf lesen -
version=draftbraucht denselben Bearbeitungszugriff wie ein Agenten-Update - 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)
icon ist nur enthalten, wenn includeIcon true ist. null bedeutet, dass der Agent kein hochgeladenes Bild hat. Sonst ist fileName icon.png oder icon.jpg. Das Bild ist PNG oder JPEG, höchstens 512 Pixel auf der langen Seite und etwa 250 KB. Create- und Update-Antworten enthalten icon nie.
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.
subAgents listet angehängte Sub-Agenten, jeweils mit agentId und requiresConfirmation. workflowIds listet angehängte Workflows. Gelöschte Agenten und Workflows fehlen.
Fehlerbehandlung
422 und 503 gelten nur, wenn duincludeIcon auf true setzt. 422 bedeutet, dass das gespeicherte Bild nicht als PNG oder JPEG zurückgegeben werden kann, auch bei einer Datei über 20 MB. 503 bedeutet, dass der Speicher das Bild nicht lesen konnte. icon: null ist kein Fehler.
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.