Mettre à jour la branche de l’agent

PATCH

/v1/convai/agents/:agent_id/branches/:branch_id

PATCH

/v1/convai/agents/:agent_id/branches/:branch_id

curl -X PATCH https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches/agtbranch_0901k4aafjxxfxt93gd841r7tv5t \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "id",
  "name": "name",
  "agent_id": "agent_id",
  "description": "description",
  "created_at": 1,
  "last_committed_at": 1,
  "is_archived": true,
  "protection_status": "writer_perms_required",
  "auto_rebase": true,
  "sync_status": {
    "last_attempt": {
      "outcome": "succeeded",
      "attempted_at": 1
    }
  },
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "current_live_percentage": 1.1,
  "parent_branch": {
    "id": "id",
    "name": "name"
  },
  "most_recent_versions": [
    {
      "id": "id",
      "agent_id": "agent_id",
      "branch_id": "branch_id",
      "version_description": "version_description",
      "seq_no_in_branch": 1,
      "time_committed_secs": 1,
      "parents": {},
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "merged_authors": [
        {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin",
          "access_source": "creator"
        }
      ]
    }
  ]
}

Met à jour les propriétés de la branche de l’agent, telles que le nom, la description, le statut d’archivage, le niveau de protection et le rebasage automatique sur main

Paramètres de chemin

agent_idstringRequis

L’ID d’un agent. Il est renvoyé lors de la création de l’agent.

branch_idstringRequis

Identifiant unique de la branche.

Requête

This endpoint expects an object.

namestringOptionnel1-140 characters

Nouveau nom de la branche. Il doit être unique au sein de l’agent.

descriptionstringOptionnel<=4096 characters

Nouvelle description de la branche. Transmettez une chaîne vide pour l’effacer.

is_archivedbooleanOptionnel

Indique si la branche doit être archivée

protection_statusenumOptionnelPar défaut writer_perms_required

Le niveau de protection de la branche

Valeurs autorisées:

auto_rebasebooleanOptionnel

Lorsque la valeur est true, rebase automatiquement cette branche sur la branche principale après chaque nouvelle version principale. Ne peut pas être activé sur la branche principale.

Réponse

Réponse réussie

idstring

namestring

agent_idstring

descriptionstring

created_atinteger

last_committed_atinteger

is_archivedboolean

protection_statusenumOptionnelPar défaut writer_perms_required

Valeurs autorisées:

auto_rebasebooleanOptionnelPar défaut false

sync_statusobjectOptionnel

Défini lorsque la branche reste synchronisée avec une autre branche, actuellement Main, dont elle récupère automatiquement les nouvelles versions. Null lorsqu’elle n’est pas synchronisée.

access_infoobjectOptionnel

Informations d’accès à la branche

current_live_percentagedoubleOptionnelPar défaut 0

Pourcentage du trafic actif sur la branche

parent_branchobjectOptionnel

Branche parente de la branche

most_recent_versionslist of objectsOptionnel

Versions les plus récentes de la branche

Erreurs

422

Branches Update Request Unprocessable Entity Error

Paramètres de chemin

En-têtes

Requête

Réponse

Erreurs