Skip to content

docs(llms): add AI/ML API provider configuration example - #7322

Open
hugoaimlapi wants to merge 5 commits into
crewAIInc:mainfrom
aimlapi:docs/aimlapi-provider
Open

docs(llms): add AI/ML API provider configuration example#7322
hugoaimlapi wants to merge 5 commits into
crewAIInc:mainfrom
aimlapi:docs/aimlapi-provider

Conversation

@hugoaimlapi

Copy link
Copy Markdown

Related issue

Fixes #7321

Summary

AI/ML API (aimlapi.com) already works with CrewAI: LiteLLM ships it as the aiml provider, and CrewAI sends any provider outside SUPPORTED_NATIVE_PROVIDERS to LiteLLM. It is just not documented, so users have to guess the aiml/ prefix and the AIML_API_KEY variable.

This PR adds an "AI/ML API" accordion to the LLM provider examples in docs/edge/en/concepts/llms.mdx, right after Nebius AI Studio, in the same shape as the other LiteLLM-backed providers:

  • the AIML_API_KEY env var
  • an LLM(...) example with model="aiml/openai/gpt-5-5"
  • a few current model ids and a link to the full list
  • the usual uv add 'crewai[litellm]' note

The same block is added to the ar, ko and pt-BR docs, as AGENTS.md asks.

Docs only. No code, no docs.json, no new dependency, nothing changes for current users.

Verification

  • Tests added or updated for the changed behavior — N/A, docs only
  • Relevant tests and quality checks pass locally — nothing to run for a docs-only change; relying on CI here

Manual checks:

  • aiml is not a native provider, so it goes to LiteLLM. The model string is never rewritten, so LiteLLM gets aiml/openai/gpt-5-5 and calls AI/ML API.
  • extra_headers needs no code: unknown LLM(...) kwargs land in additional_params in BaseLLM and are passed to the completion call.
  • Every model id in the example was checked against the live catalog.
  • CodeRabbit comments from the first round are addressed: bash fence for .env, from crewai import LLM import, ar fix.

Additional context

  • Supersedes docs(llms): add AI/ML API provider configuration example #7140, which was closed automatically before the issue existed. Same branch, same commits.
  • The extra_headers={"X-AIMLAPI-Source": "agent/crewai"} line is optional. It only tags requests for our own analytics and changes no behavior. Happy to drop it.
  • An AI assistant helped write this PR. CONTRIBUTING.md asks for the llm-generated label; I cannot add labels here, so could a maintainer add it?

AI/ML API (aimlapi.com) is OpenAI-compatible and already supported by
LiteLLM as the 'aiml' custom_llm_provider (litellm/llms/aiml/), which
this project uses for any provider outside SUPPORTED_NATIVE_PROVIDERS
- no code change needed, just documenting the existing path.
LLM(...) passes any unrecognized kwarg straight through to
litellm.completion() via additional_params, so extra_headers works
today with zero code change - verified by reading BaseLLM's
model_validator (base_llm.py:286). Opt-in only: only users who copy
this exact snippet send it.
@hugoaimlapi

Copy link
Copy Markdown
Author

Hi! I'm Hugo from aimlapi.com — an AI aggregator that gives access to 1000+ models in one API, trusted by 400k+ users. We'd love to be available as a verified provider option inside CrewAI docs — so we went ahead and opened the PR. If you have any questions - happy to answer. My contacts: hugo@aimlapi.com (email / Slack), Telegram: @hug0the

@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: d926ee94-9e5a-4a1f-bbb9-1a77e70848f6

📥 Commits

Reviewing files that changed from the base of the PR and between 1b855b4 and b46f2ff.

📒 Files selected for processing (4)
  • docs/edge/ar/concepts/llms.mdx
  • docs/edge/en/concepts/llms.mdx
  • docs/edge/ko/concepts/llms.mdx
  • docs/edge/pt-BR/concepts/llms.mdx

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The LLM provider guides for English, Arabic, Korean, and Brazilian Portuguese now include AI/ML API configuration. Each guide documents AIML_API_KEY, aiml/ model identifiers, optional CrewAI request headers, and the LiteLLM dependency.

Changes

AI/ML API provider documentation

Layer / File(s) Summary
Add AI/ML API provider examples
docs/edge/en/concepts/llms.mdx, docs/edge/ar/concepts/llms.mdx, docs/edge/ko/concepts/llms.mdx, docs/edge/pt-BR/concepts/llms.mdx
Adds localized provider sections with AIML_API_KEY, aiml/openai/gpt-5-5 usage, example model IDs, optional extra_headers, and the crewai[litellm] dependency instruction.

Merge Risk: ⚪ Minimal · up to b46f2

This adds AI/ML API setup examples to four localized LLM guides. It does not alter runtime behavior or dependencies, and no merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change: adding an AI/ML API provider configuration example for LLMs.
Description check ✅ Passed The description includes the related issue, a detailed summary, verification status, and additional context. It clearly identifies the change as documentation-only.
Linked Issues check ✅ Passed The PR satisfies issue #7321 by documenting AI/ML API in English, Arabic, Korean, and Portuguese (Brazil), including the AIML_API_KEY variable, aiml model format, sample model IDs, and the LiteLLM ins…
Out of Scope Changes check ✅ Passed All changes are limited to the requested LLM documentation examples. The optional extra_headers example is related provider configuration detail and does not introduce code, dependency, or unrelated d…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Warning

⚠️ This pull request has been flagged as potential spam (promotional) by CodeRabbit slop detection and should be reviewed carefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] docs: add AI/ML API to the LLM provider examples

2 participants