Skip to content

Add --root-path to specificy HTTP prefix#894

Draft
alvarobartt wants to merge 4 commits into
mainfrom
add-root-path
Draft

Add --root-path to specificy HTTP prefix#894
alvarobartt wants to merge 4 commits into
mainfrom
add-root-path

Conversation

@alvarobartt

Copy link
Copy Markdown
Member

What does this PR do?

This PR adds the --root-path argument so that users can specify the prefix for the HTTP API, similarly as in vLLM with FastAPI, so that instead of having http://localhost:3000/v1/embeddings, one might set --root-path jinaai/jina-embeddings-v2-base-en meaning the HTTP routes are behind http://localhost:3000/jinaai/jina-embeddings-v2-base-en instead so that the OpenAI Embeddings API sits in http://localhost:3000/jinaai/jina-embeddings-v2-base-en/v1/embeddings.

Closes #888

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline?
  • Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the documentation guidelines.
  • Did you write any new necessary tests? If applicable, did you include or update the insta snapshots?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Signed-off-by: Alvaro Bartolome <36760800+alvarobartt@users.noreply.github.com>
Signed-off-by: Alvaro Bartolome <36760800+alvarobartt@users.noreply.github.com>
Signed-off-by: Alvaro Bartolome <36760800+alvarobartt@users.noreply.github.com>
@alvarobartt alvarobartt added this to the v1.9.4 milestone Jul 9, 2026
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Signed-off-by: Alvaro Bartolome <36760800+alvarobartt@users.noreply.github.com>
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.

Support --root-path CLI Argument

2 participants