Sign in

v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Request Access Token

Request Access Token

Use this API to generate an access token.

post/oauth2/{auth}/v1/token

Query parameters

scope'machinelearning.predict' | 'machinelearning.model' | 'commercestudio.rules' | 'commercestudio.rewrites' required

The value defines the scope of access requested.

  • For the token used by the Lucidworks AI API usecase, prediction, async-prediction, and async-chunking endpoints, use "scope": "machinelearning.predict".
  • For the token used by the Lucidworks AI API model endpoint, use "scope": "machinelearning.model".
  • For the token used by the Commerce Studio Rules & Rewrites API rule operations, use "scope": "commercestudio.rules".
  • For the token used by the Commerce Studio Rules & Rewrites API query rewrite operations, use "scope": "commercestudio.rewrites".
grant_type'client_credentials' required

The client_credentials grant type is used by clients to obtain an access token in the context of the client itself, not the user.

Headers

Cache-Control'no-cache' required

The no-cache request directive asks caches to validate the response with the origin server before reuse.

Accept'application/json' required

The Accept request HTTP header indicates which content types the client can understand.

Content-Type'application/x-www-form-urlencoded' required
Example:application/x-www-form-urlencoded

The Content-Type header indicates the original media type of the resource.

Response

OK

token_type'Bearer' required

The token type, which is always a bearer token.

expires_in3600 required

The number of seconds before the access_token expires. Auth tokens expire in 1 hour. A new token is required after that time.

access_tokenstring required

This value is used for the Token parameter required by the API.

scope'machinelearning.predict' | 'machinelearning.model' | 'commercestudio.rules' | 'commercestudio.rewrites' required

The value defines the scope of access granted and matches the scope value from the request.

For the token used by the Lucidworks AI API model endpoint, use "scope": "machinelearning.model".

For the token used by all other Lucidworks AI endpoints, use "scope": "machinelearning.predict".

For the token used by the Commerce Studio Rules & Rewrites API rule operations, use "scope": "commercestudio.rules".

For the token used by the Commerce Studio Rules & Rewrites API query rewrite operations, use "scope": "commercestudio.rewrites".

Example response

{
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "gyJraWQiOiJmQlBVTF90d2ZkMy3oRjhYejRZTmRjRFROS1hzWW1xVXNqTkJjTmpaVEg4IiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULmx1Yk9ZZjk3bHFjZnlodVd2SDFCN1NBVnpOZW83NXlHYTktOG12WmtxZ28iLCJpc3MiOiJodHRwczovL2lkZW50aXR5LWRldi5sdWNpZHdvcmtzLmNvbS9vYXV0aDIvYXVzemNrM2FiY1pCYzZkWlYxZDYiLCJhdWQiOiJodHRwczovL2FwaS5sdWNpZHdvcmtzLmRldiIsImlhdCI6MTY0MzgyMzcxMiwiZXhwIjoxNjQzODI3MrEyLCJjaWQiOiIwb2ExOHI2aHFsWUFpNFRXZTFkNyIsInNjcCI6WyJjb25uZWN0ZWRzZXJ2aWNlLnF1ZXJ5Il0sInN1YiI6IjBvYTE4cjZocWxZQWk0VFdlMWQ3IiwiY3VzdG9tZXJJZCI6IjNmOTIzMzM1LWYyZTEtNGNlZC1hZDY0LTQwMDA1NDE3MzJkYiJ9.oz2tmexkkMWco5A_XT_QnNq11ssvte0HCXts8X-N7oz4-lk36jAIM0dH9IutodGR7_7NTVjM8-lvvfM6s5I7qp0mRh-svb8LR357mFxH1x7_qF4uj6y4DTnGFJoaBiqqEiuc1vMI1oq0nGKBg04dnJ6yjAV1cdCuhY7wDDXxMETETDc1PsXQmCqgkvkVFdKkFspK2WSSZn_R3dn28aG-juDTNMxaHsDwUpXenBl-3fTN9EOcTwuD5awp7CBlPIzBk1akZDoDH0qLdfuPD-mUnQS2rPn2DsM1HQ5sHTG5T27FThyvoTv0i4dZ7hkdWqapFLrdld7sSQr_Z92d-wz5gZ",
  "scope": "machinelearning.predict"
}