Using the API
API Versioning
API Versions are handled via the model name parameter. Within the same version we maintain consistent metadata and a list of supported components.
Once you lock down the version of the API you are using, you are in effect:
- Locking down the underlying LLM model family and version.
- Locking down the set of components available for use in the UI.
- Locking down any metadata (like prompts) we use for design generation.
For best practices, we recommend locking down the version of the API you are using along with the version of crayon-sdk you are using.
List of versions for UI SDK are available here:
Current Versions
The current versions are
c1-latest
: Points toc1-20250401
c1-20250401
: This is the latest version of the c1 API.
Compatibility Matrix
The following table shows the minimum required versions of our SDK packages that are compatible with each C1 API version:
C1 API Version | @crayonai/react-core | @crayonai/react-ui |
---|---|---|
c1-20250401 | ≥ 0.7.0 | ≥ 0.7.0 |