Fix CLI speech_models format and clarify API key documentation#711
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Fix CLI speech_models format and clarify API key documentation#711devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
- Add --speech-models usage example with list format to CLI docs - Update API key FAQ to reflect current dashboard UI (/app URLs) - Clarify that API keys and authentication keys are the same thing - Update account_management.mdx to mention authentication keys alias Co-Authored-By: dylan.duan <dylan.duan@assemblyai.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Collaborator
|
aside @dylan-duan-aai Hey! What is the status of this PR? Is it something you were experimenting with for automatic updates? It is WIP, ready for review? |
1 similar comment
Collaborator
|
aside @dylan-duan-aai Hey! What is the status of this PR? Is it something you were experimenting with for automatic updates? It is WIP, ready for review? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses two customer-reported documentation issues:
1. CLI
speech_modelsparameter format (cli.mdx)Customers hit validation errors because the CLI docs didn't show that
--speech-modelsrequires list format. Added a usage example and a Note callout in the existing Advanced section clarifying that model names should be space-separated arguments.2. API key documentation clarity (
how-to-get-your-api-key.mdx,account_management.mdx)Customers were confused by outdated dashboard references and the distinction between "API keys" and "authentication keys." Changes:
/dashboard/*paths to current/app/*pathsReview & Testing Checklist for Human
--speech-modelsCLI flag syntax: The existing docs use underscores for flags (e.g.--dual_channel), but this PR uses hyphens (--speech-models). Confirm the actual CLI accepts--speech-models universal-3-pro universal-2as space-separated list arguments (not comma-separated, not repeated flags, not underscored).https://www.assemblyai.com/appandhttps://www.assemblyai.com/app/api-keysare the correct current dashboard paths. Note that the signup link still points to/dashboard/signup— verify this is intentional.api-key.pngscreenshot is retained. Verify it still matches the current dashboard UI described in the updated steps (e.g. "click on 'API Keys' in the left sidebar").Notes