|
| 1 | +--- |
| 2 | +description: Learn how to get started with the AI/ML API |
| 3 | +cover: .gitbook/assets/rqiuor.jpg |
| 4 | +coverY: 0 |
| 5 | +--- |
| 6 | + |
| 7 | +# 🧭 Documentation Map |
| 8 | + |
| 9 | +This documentation portal is designed to help you choose and configure the AI **model** that best suits your needs—or one of our **solutions** (ready-to-use tools for specific practical tasks) from our available options and correctly integrate it into your code.  |
| 10 | + |
| 11 | +Have suggestions for improvement? [**Let us know!**](https://forms.aimlapi.com/doc) |
| 12 | + |
| 13 | +*** |
| 14 | + |
| 15 | +<table data-header-hidden data-full-width="false"><thead><tr><th width="281.09991455078125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><p></p><p><strong>Start with this code block</strong> <br><br><span data-gb-custom-inline data-tag="emoji" data-code="1fa81">🪁</span> Step-by-step example:</p><p><a href="quickstart/setting-up.md">Setting Up</a><br><br><span data-gb-custom-inline data-tag="emoji" data-code="1fa81">🪁</span> Choose the SDK to use:</p><p><a href="quickstart/supported-sdks.md">Supported SDKs</a></p></td><td valign="top"><pre class="language-python" data-overflow="wrap"><code class="lang-python">from openai import OpenAI |
| 16 | + |
| 17 | +client = OpenAI( |
| 18 | + base_url="https://api.aimlapi.com/v1", |
| 19 | + api_key="<YOUR_AIMLAPI_KEY>", |
| 20 | +) |
| 21 | + |
| 22 | +response = client.chat.completions.create( |
| 23 | + model="gpt-4o", |
| 24 | + messages=[{"role": "user", "content": "Write a one-sentence story about numbers."}] |
| 25 | +) |
| 26 | + |
| 27 | +print(response.choices[0].message.content) |
| 28 | +</code></pre></td></tr></tbody></table> |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +*** |
| 33 | + |
| 34 | +## Browse Models |
| 35 | + |
| 36 | +Popular | [View all 200+ models >](api-references/model-database.md) |
| 37 | + |
| 38 | +<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="api-references/text-models-llm/OpenAI/">ChatGPT</a></td><td></td><td></td><td><a href="api-references/text-models-llm/OpenAI/">OpenAI</a></td></tr><tr><td><a href="api-references/text-models-llm/DeepSeek/">DeepSeek</a></td><td></td><td></td><td><a href="api-references/text-models-llm/DeepSeek/">DeepSeek</a></td></tr><tr><td><a href="api-references/image-models/flux/">Flux</a></td><td></td><td></td><td><a href="api-references/image-models/flux/">flux</a></td></tr></tbody></table> |
| 39 | + |
| 40 | +Select the model by its **Task**, by its **Developer** or by the supported **Capabilities**: |
| 41 | + |
| 42 | +{% hint style="info" %} |
| 43 | +If you've already made your choice and know the model ID, use the [Search panel](https://docs.aimlapi.com/?q=) on your right. |
| 44 | +{% endhint %} |
| 45 | + |
| 46 | +{% tabs %} |
| 47 | +{% tab title="Models by TASK" %} |
| 48 | +{% content-ref url="api-references/text-models-llm/" %} |
| 49 | +[text-models-llm](api-references/text-models-llm/) |
| 50 | +{% endcontent-ref %} |
| 51 | + |
| 52 | +{% content-ref url="api-references/image-models/" %} |
| 53 | +[image-models](api-references/image-models/) |
| 54 | +{% endcontent-ref %} |
| 55 | + |
| 56 | +{% content-ref url="api-references/video-models/" %} |
| 57 | +[video-models](api-references/video-models/) |
| 58 | +{% endcontent-ref %} |
| 59 | + |
| 60 | +{% content-ref url="api-references/music-models/" %} |
| 61 | +[music-models](api-references/music-models/) |
| 62 | +{% endcontent-ref %} |
| 63 | + |
| 64 | +{% content-ref url="api-references/speech-models/" %} |
| 65 | +[speech-models](api-references/speech-models/) |
| 66 | +{% endcontent-ref %} |
| 67 | + |
| 68 | +{% content-ref url="api-references/moderation-safety-models/" %} |
| 69 | +[moderation-safety-models](api-references/moderation-safety-models/) |
| 70 | +{% endcontent-ref %} |
| 71 | + |
| 72 | +{% content-ref url="api-references/3d-generating-models/" %} |
| 73 | +[3d-generating-models](api-references/3d-generating-models/) |
| 74 | +{% endcontent-ref %} |
| 75 | + |
| 76 | +{% content-ref url="api-references/vision-models/" %} |
| 77 | +[vision-models](api-references/vision-models/) |
| 78 | +{% endcontent-ref %} |
| 79 | + |
| 80 | +{% content-ref url="api-references/embedding-models/" %} |
| 81 | +[embedding-models](api-references/embedding-models/) |
| 82 | +{% endcontent-ref %} |
| 83 | +{% endtab %} |
| 84 | + |
| 85 | +{% tab title="Models by DEVELOPER" %} |
| 86 | +**Alibaba Cloud**: [Text/Chat](api-references/text-models-llm/Alibaba-Cloud/) [Video](api-references/video-models/alibaba-cloud/) |
| 87 | + |
| 88 | +**Anthracite**: [Text/Chat](api-references/text-models-llm/Anthracite/) |
| 89 | + |
| 90 | +<mark style="background-color:green;">**Anthropic**</mark>: [Text/Chat](api-references/text-models-llm/Anthropic/) [Embedding](api-references/embedding-models/Anthropic/)  |
| 91 | + |
| 92 | +**BAAI**: [Embedding](api-references/embedding-models/BAAI/) |
| 93 | + |
| 94 | +**ByteDance**: [Image](api-references/image-models/bytedance/) [Video](api-references/video-models/bytedance/) |
| 95 | + |
| 96 | +**Cohere**: [Text/Chat](api-references/text-models-llm/Cohere/) |
| 97 | + |
| 98 | +<mark style="background-color:green;">**DeepSeek**</mark>: [Text/Chat](api-references/text-models-llm/DeepSeek/) |
| 99 | + |
| 100 | +**Deepgram**: [Speech-To-Text](api-references/speech-voice-models/stt/Deepgram/) [Text-to-Speech](api-references/speech-voice-models/tts/Deepgram/) |
| 101 | + |
| 102 | +<mark style="background-color:green;">**Flux**</mark>: [Image](api-references/image-models/flux/) |
| 103 | + |
| 104 | +**Google**: [Text/Chat](api-references/text-models-llm/Google/) [Image](api-references/image-models/google/) [Video](api-references/video-models/google/) [Music](api-references/vision-models/ocr-optical-character-recognition/google/) [Vision(OCR)](api-references/music-models/google/) [Embedding](api-references/embedding-models/Google/) |
| 105 | + |
| 106 | +<mark style="background-color:green;">**Kling AI**</mark>: [Video](api-references/video-models/Kling-AI/) |
| 107 | + |
| 108 | +**Meta**: [Text/Chat](api-references/text-models-llm/Meta/) |
| 109 | + |
| 110 | +<mark style="background-color:green;">**MiniMax**</mark>: [Text/Chat](api-references/text-models-llm/MiniMax/) [Video](api-references/video-models/MiniMax/) [Music](api-references/music-models/MiniMax/) |
| 111 | + |
| 112 | +**Mistral AI**: [Text/Chat](api-references/text-models-llm/Mistral-AI/) [Vision(OCR)](api-references/vision-models/ocr-optical-character-recognition/mistral-ai/) |
| 113 | + |
| 114 | +**NVIDIA**: [Text/Chat](api-references/text-models-llm/NVIDIA/) |
| 115 | + |
| 116 | +**NousResearch**: [Text/Chat](api-references/text-models-llm/NousResearch/) |
| 117 | + |
| 118 | +<mark style="background-color:green;">**OpenAI**</mark>: [Text/Chat](api-references/text-models-llm/OpenAI/) [Image](api-references/image-models/OpenAI/) [Speech-To-Text](api-references/speech-voice-models/stt/OpenAI/) [Embedding](api-references/embedding-models/OpenAI/)  |
| 119 | + |
| 120 | +**RecraftAI**: [Image](api-references/image-models/RecraftAI/) |
| 121 | + |
| 122 | +**Runway**: [Video](api-references/video-models/runway/) |
| 123 | + |
| 124 | +<mark style="background-color:green;">**Stability AI**</mark>: [Image](api-references/image-models/Stability-AI/) [Music](api-references/music-models/Stability-AI/) [3D-Generation](api-references/3d-generating-models/Stability-AI/) |
| 125 | + |
| 126 | +**Together AI**: [Embedding](api-references/embedding-models/Together-AI/) |
| 127 | + |
| 128 | +**xAI**: [Text/Chat](api-references/text-models-llm/xAI/) |
| 129 | +{% endtab %} |
| 130 | + |
| 131 | +{% tab title="Models by CAPABILITY" %} |
| 132 | +{% content-ref url="capabilities/completion-or-chat-models.md" %} |
| 133 | +[completion-or-chat-models.md](capabilities/completion-or-chat-models.md) |
| 134 | +{% endcontent-ref %} |
| 135 | + |
| 136 | +{% content-ref url="capabilities/streaming-mode.md" %} |
| 137 | +[streaming-mode.md](capabilities/streaming-mode.md) |
| 138 | +{% endcontent-ref %} |
| 139 | + |
| 140 | +{% content-ref url="capabilities/code-generation.md" %} |
| 141 | +[code-generation.md](capabilities/code-generation.md) |
| 142 | +{% endcontent-ref %} |
| 143 | + |
| 144 | +{% content-ref url="capabilities/thinking-reasoning.md" %} |
| 145 | +[thinking-reasoning.md](capabilities/thinking-reasoning.md) |
| 146 | +{% endcontent-ref %} |
| 147 | + |
| 148 | +{% content-ref url="capabilities/function-calling.md" %} |
| 149 | +[function-calling.md](capabilities/function-calling.md) |
| 150 | +{% endcontent-ref %} |
| 151 | + |
| 152 | +{% content-ref url="capabilities/image-to-text-vision.md" %} |
| 153 | +[image-to-text-vision.md](capabilities/image-to-text-vision.md) |
| 154 | +{% endcontent-ref %} |
| 155 | + |
| 156 | +{% content-ref url="capabilities/web-search.md" %} |
| 157 | +[web-search.md](capabilities/web-search.md) |
| 158 | +{% endcontent-ref %} |
| 159 | +{% endtab %} |
| 160 | +{% endtabs %} |
| 161 | + |
| 162 | +## Browse Solutions |
| 163 | + |
| 164 | +* [AI Search Engine](solutions/ai-search-engine/) – if you need to create a project where information must be found on the internet and then presented to you in a structured format, use this solution. |
| 165 | +* [OpenAI Assistants](solutions/openai/assistants/) – if you need to create tailored AI Assistants capable of handling customer support, data analysis, content generation, and more.  |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | +*** |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | +## Going Deeper |
| 174 | + |
| 175 | +<table data-header-hidden data-full-width="false"><thead><tr><th width="409.4000244140625"></th><th valign="top"></th></tr></thead><tbody><tr><td><p><strong>Use more text model capabilities in your project:</strong><br><br><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/completion-or-chat-models.md">Completion and Chat Completion</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/function-calling.md">Function Calling</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/streaming-mode.md">Streaming Mode</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/image-to-text-vision.md">Vision in Text Models (Image-to-Text)</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/code-generation.md">Code Generation</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/thinking-reasoning.md">Thinking / Reasoning</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/web-search.md">Web Search</a><br><br></p></td><td valign="top"><p><strong>Miscellaneous</strong>:<br><br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="broken-reference">Integrations</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f4d7">📗</span> <a href="broken-reference">Glossary</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> <a href="broken-reference">Errors and Messages</a></p><p><span data-gb-custom-inline data-tag="emoji" data-code="2753">❓</span> <a href="broken-reference">FAQ</a> </p><p><br></p></td></tr><tr><td><strong>Learn more about developer-specific features:</strong><br><br><span data-gb-custom-inline data-tag="emoji" data-code="1f4d6">📖</span> <a href="capabilities/anthropic.md">Features of Anthropic Models</a><br></td><td valign="top"></td></tr></tbody></table> |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | +## Have a Minute? Help Make the Docs Better! |
| 180 | + |
| 181 | +We’re currently working on improving our documentation portal, and your feedback would be **incredibly** helpful! Take [**a quick 5-question survey**](https://tally.so/r/w4G9Er) (no personal info required!) |
| 182 | + |
| 183 | +You can also rate each individual page using the built-in form on the right side of the screen: |
| 184 | + |
| 185 | +<figure><img src=".gitbook/assets/rateform-5.webp" alt=""><figcaption></figcaption></figure> |
0 commit comments