Token
Manage Tokens
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
A standard query parameter is used to search for specific values.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
List of tokens.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
GET /ai-service/{tenant}/agentic/tokens HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "emporix--openai",
"name": "Emporix OpenAi Token"
},
{
"id": "openai",
"name": "OpenAi Token"
}
]Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
A standard query parameter is used to search for specific values.
List of tokens.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
POST /ai-service/{tenant}/agentic/tokens/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"q": "name:~Support"
}[
{
"id": "emporix--openai",
"name": "Emporix OpenAi Token"
},
{
"id": "openai",
"name": "OpenAi Token"
}
]Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Fields to be returned in the response.
A single token.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
GET /ai-service/{tenant}/agentic/tokens/{tokenId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "openai",
"name": "OpenAi Token"
}Updates or creates a specified token by replacing all of its existing data with data from the request body. If the metadata.version is provided then optimistic locking is enabled and version must match the version in the database.
Important: The value field cannot be updated, once created token cannot change value field.
Required scopes
ai.agent_manage
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
ID of created token.
The resource has been successfully updated.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
There are three possible reasons:
- Resource with given code already exists, please choose unique code for your resource
- Optimistic locking failed. If user sends metadata/version attribute which is outdated (someone else updated resource in the time user was performing his changes). User should retrieve the latest product data and retry the request.
- Optimistic locking failed. User did not provide metadata/version attribute in update request, but someone else updated product while it was internally handled by product service. Resending the same request can result in successful update, but the update can override recently persisted changes.
PUT /ai-service/{tenant}/agentic/tokens/{tokenId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"name": "OpenAI Token",
"value": "sk-secret"
}{
"id": "a81bc81b-dead-4e5d-abff-90865d1e13b1"
}Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Allows you to remove a given entity even if it is used as a dependency in other entries. In that case, the removed entity is unassigned from other entries.
falseGiven token has been deleted.
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
DELETE /ai-service/{tenant}/agentic/tokens/{tokenId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Partially updates a single token document with given information. Single update may contain multiple partial updates in the form of an array. It contains the allowed operations list:
add(adding an item to the items list)remove(removing an item from the items list)replace(replacing an item with given ID with new definition)
Important: The value field cannot be updated, once created token cannot change value field.
Required scopes
ai.agent_manage
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Partial update operation list.
/nameValue of the string type.
Any part of the details object.
No Content
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
PATCH /ai-service/{tenant}/agentic/tokens/{tokenId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
[
{
"op": "REPLACE",
"path": "/name",
"value": "New OpenAI Token"
}
]No content
Last updated
Was this helpful?