feat:Add new endpoint for retrieving conversational AI agents in ElevenLabs API

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint for retrieving a list of conversational AI agents.
  • Added support for pagination and filtering by agent name.

• Documentation

  • Updated API documentation to include new endpoint details and response schemas.

[coderabbitai]

Walkthrough

The changes introduce a new endpoint to the ElevenLabs API for retrieving a list of conversational AI agents. The endpoint /v1/convai/agents supports a GET method with query parameters for pagination and filtering. It requires an API key for authentication and returns a structured JSON response, including metadata about the agents. Two new schemas, GetAgentsPageResponseModel and AgentSummaryResponseModel, are defined to structure the response data.

Changes

File	Change Summary
src/libs/ElevenLabs/openapi.yaml	Added new endpoint GET /v1/convai/agents for fetching conversational AI agents with pagination and filtering. Defined new schemas: GetAgentsPageResponseModel and AgentSummaryResponseModel.

Poem

In the garden of code, where the agents play,
A new path has bloomed, brightening the day.
With a flick of a key, they come into sight,
Fetching tales of the agents, oh what a delight!
So hop on this journey, let queries take flight,
In the world of AI, everything feels right! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/libs/ElevenLabs/openapi.yaml (1)

3248-3264: Consider enhancing schema documentation

While the AgentSummaryResponseModel structure is sound, consider adding descriptions for properties to improve API usability:

• What is the format/purpose of agent_id?
• What timezone is created_at_unix_secs in?
• Are there any constraints on the name field?

     AgentSummaryResponseModel:
       title: AgentSummaryResponseModel
       required:
         - agent_id
         - name
         - created_at_unix_secs
       type: object
       properties:
         agent_id:
           title: Agent Id
           type: string
+          description: Unique identifier for the conversational AI agent
         name:
           title: Name
           type: string
+          description: Display name of the agent
         created_at_unix_secs:
           title: Created At Unix Secs
           type: integer
+          description: Unix timestamp (in seconds) when the agent was created, in UTC

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5b82dde and 7ebf382.

⛔ Files ignored due to path filters (9)

• src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.GetConvaiAgents.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.ElevenLabsClient.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.GetConvaiAgents.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.IElevenLabsClient.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentSummaryResponseModel.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetAgentsPageResponseModel.g.cs is excluded by !**/generated/**
• src/libs/ElevenLabs/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/ElevenLabs/openapi.yaml (2 hunks)

🔇 Additional comments (2)

src/libs/ElevenLabs/openapi.yaml (2)

9-48: Well-designed REST endpoint for agent listing!

The new /v1/convai/agents endpoint follows API best practices with:

• Standard cursor-based pagination
• Consistent authentication pattern
• Clear query parameters and response structure

---

3230-3248: Well-structured pagination response model!

The GetAgentsPageResponseModel follows consistent patterns with:

• Clear pagination metadata (has_more, next_cursor)
• Properly defined required fields
• Type safety for all properties