Conversation
WalkthroughThe OpenAPI specification for the ElevenLabs API was updated to add a new conversation filtering query parameter, introduce agent category metadata in agent-related schemas, and include a discount percentage field in the invoice schema. These changes enhance endpoint capabilities and data models for conversations, agents, and invoices. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant API
Note over Client,API: Filtering Conversations by Start Time
Client->>API: GET /v1/convai/conversations?call_start_after_unix=TIMESTAMP
API-->>Client: Returns conversations started after TIMESTAMP
Note over Client,API: Creating or Updating an Agent with Categories
Client->>API: POST/PATCH /v1/convai/agents (with categories array)
API-->>Client: Returns agent info including categories
Note over Client,API: Retrieving Invoice with Discount
Client->>API: GET /v1/invoices/{id}
API-->>Client: Returns invoice including discount_percent_off
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
src/libs/ElevenLabs/openapi.yaml (2)
6200-6207: Typo and phrasing in query parameter description
Thedescriptionfields both say "filter conversations after to this start date." Remove the extraneous "to" and clarify that it filters by a Unix timestamp after a given time. For example:-description: Unix timestamp (in seconds) to filter conversations after to this start date. +description: Unix timestamp (in seconds) to filter conversations that started after this time.
14908-14912: Clarify invoice discount example formatting
The description uses[20.0f], which resembles a language-specific float suffix and may confuse clients. Consider simplifying to20.0or20:-description: 'The discount applied to the invoice. E.g. [20.0f] for 20% off.' +description: 'The discount applied to the invoice as a percentage (e.g., 20.0 for 20% off).'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (11)
src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.CreateConvaiAgentsCreate.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.EditConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.GetConvaiConversations.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.CreateConvaiAgentsCreate.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.EditConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.GetConvaiConversations.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentSummaryResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyCreateAgentV1ConvaiAgentsCreatePost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatch.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetAgentResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.InvoiceResponseModel.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/ElevenLabs/openapi.yaml(8 hunks)
🔇 Additional comments (4)
src/libs/ElevenLabs/openapi.yaml (4)
8581-8587: Agent summary schema: markingcategoriesas required
Addingcategoriesto the required list ensures all agent summaries include category metadata. This aligns with the design to treat categories as core metadata.
8597-8603: Definecategoriesproperty correctly
The newcategoriesarray (of strings) is well-defined with a clear title and description. It’s consistent with other schema conventions.
8611-8615: Update example for agent categories
The illustrative list of categories helps clients understand valid values. Approved.
13944-13949: Addcategoriesto agent detail response
Includingcategoriesin the detailed agent response ensures clients receive full metadata about the agent. The schema and description are consistent.
| categories: | ||
| title: Categories | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: Categories to help classify and filter the agent | ||
| nullable: true | ||
| example: | ||
| - Customer Support | ||
| - Technical Help | ||
| - Eleven |
There was a problem hiding this comment.
Incorrect addition of categories to avatar upload body
The Body_Post_Agent_avatar_v1_convai_agents__agent_id__avatar_post schema is for uploading an avatar, not updating agent metadata. The categories field should not be part of this request body. Please remove or correct its placement.
🤖 Prompt for AI Agents (early access)
In src/libs/ElevenLabs/openapi.yaml around lines 10518 to 10528, the `categories` field is incorrectly included in the avatar upload request body schema `Body_Post_Agent_avatar_v1_convai_agents__agent_id__avatar_post`. Remove the entire `categories` property from this schema to ensure the avatar upload body only contains relevant fields for uploading an avatar and does not include agent metadata.
| categories: | ||
| title: Categories | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: Categories to help classify and filter the agent | ||
| nullable: true | ||
| example: | ||
| - Customer Support | ||
| - Technical Help | ||
| - Eleven |
There was a problem hiding this comment.
Misplaced categories in voice PVC body
The Body_Create_PVC_voice_v1_voices_pvc_post schema is for voice PVC creation, not agent metadata. The categories field appears to be intended for agent creation PATCH/POST bodies. Please remove or relocate this property to the correct agent endpoints.
🤖 Prompt for AI Agents (early access)
In src/libs/ElevenLabs/openapi.yaml around lines 9407 to 9417, the `categories` field is incorrectly included in the voice PVC creation body schema `Body_Create_PVC_voice_v1_voices_pvc_post`. This field is meant for agent metadata in agent creation PATCH/POST endpoints. Remove the `categories` property from this voice PVC schema and relocate it to the appropriate agent creation request bodies to maintain correct API specification structure.
Summary by CodeRabbit