API reference documents
SambaStudio provides three APIs for inference tasks. This document describes the three available APIs and their usage recommendations.
API descriptions
- API V1
-
API V1 represent SambaStudio’s legacy APIs. These APIs are still functional, but are gradually being phased out. These older APIs are compatible with all models, but lack some of the newer features and optimizations available.
- API V2
-
The API V2 improves on API V1 and offers better structure and support for newer features, such as batched inputs and a global queue for improved performance.
- OpenAI compatible API
-
The OpenAI compatible APIs are an OpenAI compatible version of the API V2 with support for all API V2 features. They are designed to provide compatibility with OpenAI-style formats and work with the OpenAI client. To utilize the latest features and improvements of SambaStudio APIs, we recommend that you migrate to the OpenAI compatible APIs for supported models.
API usage
The table below describes the compatibility and recommended usage for the SambaStudio APIs.
| Model Type | API V1 | OpenAI compatible API | Recommended API |
|---|---|---|---|
Standalone models |
Yes |
No |
|
CoE-based models (user created CoE or Samba-1 Turbo models) |
Yes |
No |
|
Vision models |
Yes |
No (coming soon) |
|
Non-CoE embedding models |
Yes |
No (coming soon) |
|
CoE embedding models |
Yes |
No (coming soon) |