Skip to content

Conversation

devin-ai-integration[bot]
Copy link
Contributor

feat: add X-Client-Id header with python-sdk- format

Summary

This PR adds automatic inclusion of an X-Client-Id header to all API requests made by the Python SDK. The header value follows the format python-sdk-<version> where version is dynamically imported from vlmrun.version.__version__. The implementation allows users to override the default header by providing their own X-Client-Id in the request headers.

Key changes:

  • Import version from vlmrun.version for dynamic header value
  • Add X-Client-Id header to _request_with_retry method in APIRequestor class
  • Header is only added if not already present, allowing user override
  • Uses format python-sdk-{__version__} as specified in requirements

Review & Testing Checklist for Human

  • Verify version import: Confirm that vlmrun.version.__version__ correctly imports the current SDK version
  • Test header override: Verify that providing X-Client-Id in request headers properly overrides the default value
  • End-to-end API testing: Make actual API calls and inspect request headers to ensure X-Client-Id appears with correct format (e.g., python-sdk-0.3.3)
  • Import style check: Ensure the version import follows the project's import ordering conventions

Notes

- Add X-Client-Id header to BaseRequestor with format python-sdk-<version>
- Allow header override when provided in headers parameter
- Import version from vlmrun.version for dynamic version info
- Header is only added if not already present in request headers

Co-Authored-By: [email protected] <[email protected]>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Contributor Author

Closing due to inactivity for more than 7 days. Configure here.

Copy link
Contributor

@spillai spillai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@spillai spillai merged commit 261897d into main Oct 1, 2025
8 checks passed
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.

2 participants