If you have enabled authentication, then you need a Model API Key to call a model. If
you are not a collaborator on a particular project, then you cannot access the models within
that project using the Model API Key that you generate. You need to be added as a collaborator
by the admin or the owner of the project to use the Model API Key to access a
model.
There are two types of API keys used in Cloudera Data
Science Workbench:
API Key: This is used in the CDSW-specific internal APIs for CLI
automation. This can’t be deleted and neither does it expire. This API Key is not
required when sending requests to a model.
Model API Key: These are used to authenticate requests to a model. You
can choose the expiration period and delete them when no longer needed.
You can generate more than one Model API Key to use with your model, depending on
the number of clients that you are using to call the models.
Sign in to the Cloudera Data Science Workbench.
Click Settings from the left navigation pane.
On the User Settings page, click the API
Keys tab.
Select an expiry date for the Model API Key, and click Create API
keys.
An API key is generated along with a Key ID. If you do not specify an expiry date,
then the generated key is active for one year from the current date.
To test the Model API Key:
Navigate to your project and click Models from the
left navigation pane.
On the Overview page, paste the Model API Key in the
Model API Key field that you had generated in the
previous step and click Test.
The test results, along with the HTTP response code and the Replica ID are
displayed in the Results table.
If the test fails and you see the following message, then you must get added
as a collaborator on the respective project by the admin or the creator of the
project:
"User APikey not authorized to access model": "Check APIKEY permissions or model authentication permissions"