Persona-API-Endpunkte

Vollständige Referenz für die REST-API-Endpunkte zu Personas - KI-Agenten-Personas auflisten, erstellen, aktualisieren, löschen, duplizieren, umschalten und Analytics einsehen.

8 Min. Lesezeit
apipersonasagents

Personas definieren Persönlichkeit, Fähigkeiten und Modell-Präferenzen von KI-Coding-Agenten. Jede Persona kann den Pipeline-Schritten eines Workflows zugewiesen werden, um zu steuern, wie sich Agenten während der Ausführung verhalten. Die Persona-API bietet 9 Endpunkte für vollständiges Lifecycle-Management.

Endpunkte

GET /api/v1/personas/list

Alle Personas des Projekts auflisten.

curl -H "Authorization: Bearer cc_live_..." \
  https://<deployment>.convex.site/api/v1/personas/list

GET /api/v1/personas/get

Eine einzelne Persona per ID abrufen.

Query-Parameter:

  • id (erforderlich) -- Die Persona-Dokument-ID
curl -H "Authorization: Bearer cc_live_..." \
  "https://<deployment>.convex.site/api/v1/personas/get?id=..."

GET /api/v1/personas/analytics

Analytics und Nutzungsstatistiken einer Persona einsehen.

Query-Parameter:

  • id (erforderlich) -- Die Persona-Dokument-ID
  • days (optional) -- Anzahl der zurückliegenden Tage (Standard: gesamter Zeitraum)

POST /api/v1/personas/create

Eine neue Persona erstellen.

curl -X POST -H "Authorization: Bearer cc_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Senior Architect",
    "description": "Expert in system design and code review",
    "type": "checker",
    "cliId": "claude_code",
    "model": "claude-sonnet-4-20250514",
    "thinkingEffort": "high",
    "instructions": "Focus on architecture, performance, and security.",
    "selectedSkills": ["code-review", "architecture"],
    "isEnabled": true
  }' \
  https://<deployment>.convex.site/api/v1/personas/create

Body-Felder:

  • name (string, erforderlich) -- Anzeigename
  • description (string, optional) -- Menschenlesbare Beschreibung
  • type (string, erforderlich) -- Persona-Typ (z. B. designer, checker, optimizer)
  • cliId (string, optional) -- Bezeichner des CLI-Tools
  • model (string, optional) -- LLM-Modell-ID
  • thinkingEffort (string, optional) -- Stufe des Thinking-Effort
  • instructions (string, optional) -- Eigene Anweisungen
  • selectedSkills (array, optional) -- Skill-Bezeichner
  • isEnabled (boolean, optional) -- Ob die Persona aktiv ist

POST /api/v1/personas/update

Eine bestehende Persona aktualisieren. Alle Body-Felder außer personaId sind optional.

{
  "personaId": "...",
  "name": "Updated Name",
  "model": "claude-opus-4-20250514",
  "learningsEnabled": true
}

Weitere Felder: description, type, thinkingEffort, instructions, selectedSkills, isEnabled, learningsEnabled.

POST /api/v1/personas/delete

Eine Persona löschen.

{ "personaId": "..." }

POST /api/v1/personas/duplicate

Eine Kopie einer bestehenden Persona erstellen.

{ "personaId": "..." }

POST /api/v1/personas/toggle

Den Aktivierungsstatus einer Persona umschalten.

{ "personaId": "..." }

POST /api/v1/personas/bulk-delete

Mehrere Personas in einer Anfrage löschen.

{ "personaIds": ["id1", "id2", "id3"] }