エージェントを一覧表示

GET

/v1/convai/agents

GET

/v1/convai/agents

curl -G https://api.elevenlabs.io/v1/convai/agents \
     -d archived=true \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d show_only_owned_agents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d tags=tags

{
  "agents": [
    {
      "agent_id": "J3Pbu5gP6NNKBscdCdwB",
      "name": "My Agent",
      "voice_id": "UCaNsl8F6Xh4GALkVMLS",
      "tags": [
        "Customer Support",
        "Technical Help",
        "Eleven"
      ],
      "created_at_unix_secs": 1716153600,
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john@example.com",
        "role": "admin"
      },
      "last_call_time_unix_secs": 1,
      "archived": false
    }
  ],
  "has_more": false,
  "next_cursor": "123"
}

エージェントとそのメタデータのリストを返します。

クエリパラメータ

page_sizeintegerオプション1-100デフォルト値 30

返すエージェントの最大数です。100を超えることはできず、デフォルトは30です。

searchstringオプション

エージェント名で検索します。

archivedbooleanオプション

アーカイブ状態でエージェントをフィルター

show_only_owned_agentsbooleanオプションデフォルト値 falseDeprecated

trueに設定すると、エンドポイントは他者から共有されたエージェントを除外し、自分が所有するエージェントのみを含めます。非推奨：代わりにcreated_by_user_idを使用してください。

created_by_user_idstringオプション

作成者ユーザーIDでエージェントをフィルターします。設定すると、このユーザーが作成したエージェントのみが返されます。show_only_owned_agentsより優先されます。認証済みユーザーを指定するには’@me’を使用します。

tagsstringオプション

タグでエージェントをフィルターします。複数のタグのいずれかに一致させるには、パラメータを繰り返し指定します。

sort_directionenumオプション

結果の並べ替え方向

許可された値:

sort_byenumオプション

結果の並べ替えに使用するフィールド

許可された値:

cursorstringオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

agentslist of objects

エージェントとそのメタデータのリストです。

has_moreboolean

ページネーションで取得できるエージェントがさらにあるかどうか

next_cursorstringオプション

エージェントをページネーションするための次のカーソル。

エラー

422

Agents List Request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー