Upcoming API Changes
Learn about scheduled API changes
Here is a list of changes to the API that we want you to be aware of well in advance as they may affect how you use Clarifai's platform. These changes include scheduled downtime and other improvements in stability, performance or functionality of the Clarifai platform in order to better serve you as a customer.
Some of these changes may not be backward compatible and thus require you to update how you call our APIs. We created this page with the mindset of being as transparent as possible so you can plan any corresponding changes in advance and minimize any interruptions to your usage of Clarifai.
The dates listed in the following tables are the date we plan to make the change. We may actually make the change in the days following the specified date. However, to be safe, your client-side code needs updating before that date to minimize any downtime to your applications.
We will continue to update this page regularly, so a good way to always stay up to date is to watch our documentation repo on GitHub.
Changes to the Use of PATs and API Keys
|March 30th 2023||(Breaking change) |
Critical changes to the use of PATs and API keys
|An upcoming version of Clarifai’s API, 9.3, will significantly change how personal access tokens (PATs) and API keys work. We plan to implement this change on March 30, 2023, providing 45 days to change the way your applications authenticate on our platform. |
Terminology: If any of the terms used here are unfamiliar, you can check them in our glossary. Specifically, we mention models, workflows, public, private, collaboration, organization, and community.
Why are we making this change? With PATs you can access resources for which you’re a collaborator or teammate. You can also access public content shared by any user, in addition to all your private content across all of your apps. This simplifies the use of all the resources you have access to unlike using API keys that are restricted to a single application. PAT provides a consistent, secure, and robust authentication method. Finally, for Enterprise clients, Org functionality is PAT only and this change creates a consistent method of authentication across the platform.
What is changing? Previously, you could use API keys to access any model, concept, or workflow owned by the app scoped to the API key, as well as those owned by the user
We do apologize for any inconvenience this causes, however, we are confident that this is a positive change that will simplify the usage of the platform going forward and make it easier to leverage AI created by other people on our platform!
Thank you for your understanding and please feel free to reach out for any help.
|January 26th 2023||Deprecation of ||When using the PostModels endpoint to create a custom embedding-classifier model, you could include the |
The variable accepted a Boolean value and specified whether a pre-stored dataset, of (usually) negative embeddings, should be added to the training process of your model. This generally leads to higher model accuracy without any additional effort on your end.
This change will also affect the PostModelVersions endpoint.
Updates to Model and Model Version Endpoints
|January 20, 2023||Critical Updates to Model and Model Version Endpoints|
Changes to PostModelOutputs and PostWorkflowResults Responses
|January 4th 2023||Exclusion of Some Fields From PostModelOutputs and PostWorkflowResults Prediction Responses|
Other Previous Changes
|November 22, 2022||Deprecation of ||The generic search API will be deprecated in favor of |
|January 20, 2022||Deprecation of ||To make Clarifai Model IDs more readable and user friendly, we plan to make the following API/UI changes during the week of Jan 17th. Please see user impact and suggestions below and contact firstname.lastname@example.org if you have any questions. |
|November 24, 2021. 9:00am ET||Deprecation of type option||The |
|February 12, 2021. 9:00am ET||Deprecation of ||The |
|October 16, 2020. 9:00am ET||Deprecation of Demographics Model||To reduce the risk of race bias in our own models, we have constructed a new approach to visual recognition of race. We've also divided age, race and gender recognition into separate models, and then packaged the models into a new public Demographics Workflow. This new approach provides much more flexibility, and makes outputs easier to parse. We will be retiring the current demographics model on October 16th, 2020. Please reference this blog post, and our API documentation for more information about how you can update your code to take advantage of the new workflow.|
|October 20, 2020. 9:00am ET||Model Training Do Not Wait For Inputs To Be Processed||Currently, when we train a context-based classifier model, we wait for all inputs to be added to your app before a model version is created and processed, with a 1 hour training timeout. In the future, we will use any available inputs and annotations that are available at the time a model version is created for training. If the input is pending or in progress, those inputs and associated annotations will not be used for training. You can use https://api.clarifai.com/v2/inputs/status to check input counts for each status.|
|February 27, 2020. 9:00am ET||Deprecation of Face object from API||The Face object in our API responses will be deprecated in favor of a list of Concepts that other model types return. This should only effect users of the Celebrity, Demographics, or custom face recognition models where the |
|February 24, 2020. 9:00am ET||Consolidation of Input Related Status Codes||As we support more media types, it is impractical to have status codes for each. Thus status codes will now be prefixed |
|February 12, 2020. 9:00am ET||Deprecation of Face model type names||The |
|February 3, 2020. 9:00am ET||The overwrite action when patching inputs currently has some inconsistent behavior. If you patch |
|February 1, 2020. 9:00am ET||Deprecation of Focus Model||The Focus model will no longer be supported and will be removed from our API after this point in time. If you have requests for recognizing focus and blurry regions within images please contact email@example.com so that we can help you directly.|
|November 20, 2019. 9:00am ET||In some requests we used to allow cropping of images during the request using the |
|September 30, 2019. 5:00pm ET||Along the same lines as |
|September 24, 2019. 5:00pm ET||We are cleaning up some inconsistent behavior in the API where a single image added with |
|September 11, 2019. 9:00am ET||Scheduled Database Downtime||We plan to upgrade our database to make it faster and provide more space for your applications. We expect a few minutes of downtime during this upgrade but you should plan for up to an hour of downtime in case things don't go as expected. This will primarily affect the following uses of our platform: POST/GET/PATCH/DELETE inputs, Search, Custom Training, Model Evaluation|