List agent branches

GET

/v1/convai/agents/:agent_id/branches

GET

/v1/convai/agents/:agent_id/branches

curl -G https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches \
     -d include_archived=true \
     -d include_commit_status=true \
     -d limit=1

{
  "results": [
    {
      "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",
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "current_live_percentage": 1.1,
      "parent_branch_id": "parent_branch_id",
      "draft_exists": true,
      "draft_created_at": 1,
      "draft_is_behind_tip": true,
      "calls_7d": 1,
      "commits_ahead": 1,
      "commits_behind": 1,
      "merged_into_branch_id": "merged_into_branch_id"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "page_size": 1
  }
}

Returns a list of branches an agent has

Pfadparameter

agent_idstringErforderlich

The id of an agent. This is returned on agent creation.

Abfrageparameter

include_archivedbooleanOptionalStandardwert ist false

Whether archived branches should be included

limitintegerOptional<=100Standardwert ist 100

How many results at most should be returned

include_commit_statusbooleanOptionalStandardwert ist false

Whether to compute how far each branch has diverged from main (commits_ahead/commits_behind). This walks the version DAG of every branch, so it is slow on agents with long histories and is off by default, leaving those fields null.

Antwort

Successful Response

resultslist of objects

metaobjectOptional

Fehler

422

Branches List Request Unprocessable Entity Error

Pfadparameter

Header

Abfrageparameter

Antwort

Fehler