- Table of Contents
- Quickstart:
- Authentication
- Installation
- Usage
Read the getting started guide for more information on how to use Mantium.
- Make an account by visiting app.mantiumai.com and select Register.
- Enter your email address and create a password. After you've verified the email, you'll be able to sign in to the Mantium application. You'll also need your username and password to obtain a token for API use.
Install Node.js on your computer. To install JavaScript Library please use the following command.
npm install @mantium/mantiumapi const mantiumAi = require('@mantium/mantiumapi');
// bearer_id is received in response after successful login using auth login method.
mantiumAi.api_key = bearer_id
// bearer_id is required to pass in every header as value for Authorization.get started with the login and use the API
Obtain access token for a user Requirements: username: user's username password: user's password Document link
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
const loginResponse = await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set as a api_key
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
console.log(loginResponse);
console.log('Token', mantiumAi.api_key);
})();{
data: {
id: 'some-long-id',
type: 'auth_login',
attributes: {
bearer_id: 'some-long-bearer-id',
expires_on: '2021-09-27T15:19:50+00:00',
token_type: 'Bearer'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Invalidate a user's Access token (logout) Requires HTTP Authorization with the bearer_id Requirements: bearer_id: bearer id Document link
const mantiumAi = require('@mantium/mantiumapi');
// This method throw error as we are not passing the Authorization [bearer_id]
(async () => {
const logoutResponse = await mantiumAi.Auth().resetPassword({
email: 'useremail@somedomain.com'
})
.then((response) => {
return response;
});
})();
// Correct way to do this
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
const logoutResponse = await mantiumAi.Auth().revokeToken().then((response) => {
return response;
});
console.log(logoutResponse);
})();{
data: {
id: 'some-long-id',
type: 'token_revoke',
attributes: {
error: null,
message: 'The authorization token has been successfully revoked'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get all of the supported ai_methods for a provider
Require AI Provider name (case sensitive)* Document link
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.AiMethods('openai').list({ 'page': 1, 'size': 20 }).then((response) => {
console.log(response);
});
})();{
data: [
{
id: 'type',
type: 'object',
attributes: {
name: 'answers',
api_name: 'answers',
description: 'Returns answers',
shareable: false,
ai_provider: {
name: 'OpenAI',
description: 'OpenAI -- https://openai.org'
},
ai_engines: [
{
name: 'davinci',
use_cases: 'some use cases',
description: 'Some long description',
cost_ranking: 100
}
]
},
relationships: {}
}
],
included: [],
meta: {},
links: { total_items: 4, current_page: 1 }
}Get available AI engines
Get all of the configured and available AI engines
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
Document link
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.AiEngines().all({ 'page': 1, 'size': 20 }).then((response) => {
console.log(response);
});
})();{
data: [
{
id: 'davinci',
type: 'ai_engine',
attributes: {
name: 'davinci',
description: 'Some long description',
use_cases: 'some use cases',
ai_provider: 'OpenAI',
cost_ranking: '100'
},
relationships: {}
}],
included: [],
meta: {},
links: { total_items: 17, current_page: 1 }
}List all of the AI Engines for a specific AI Provider AI Provider name (case sensitive)
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
const providers = ["openai",
"cohere",
"mantium",
"OpenAI",
"Cohere",
"Mantium"];
for (let provider of providers) {
const methodResponse = await mantiumAi.AiEngines(provider).byProvider({ 'page': 1, 'size': 20 }).then((response) => {
return response;
});
console.log(methodResponse);
}
})();// *********** Response for Cohere ***********
{
data: [
{
id: 'baseline-shrimp',
type: 'ai_engine',
attributes: {
name: 'baseline-shrimp',
description: 'Some long description',
use_cases: 'some use cases',
ai_provider: 'Cohere',
cost_ranking: '24'
},
relationships: {}
}
],
included: [],
meta: {},
links: { total_items: 9, current_page: 1 }
}Get the details for a specific AI Engine
require: AI Engine name
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.AiEngines('ada').byName().then((response) => {
console.log(response);
});
})();// *********** Response for ada ***********
{
data: {
id: 'ada',
type: 'ai_engine',
attributes: {
name: 'ada',
description: 'Some long description',
use_cases: 'some use cases',
ai_provider: 'OpenAI',
cost_ranking: '70'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get all of the tags for your selected organization.
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().list({ 'page': 1, 'size': 20 }).then((response) => {
console.log('*********** Tag list *********');
console.log(response);
});
})();{
data: [
{
id: 'some-long-id',
type: 'tag',
attributes: {
tag_id: 'some-long-id',
name: 'My Tag',
description: 'This is a description',
organization_id: 'some-long-id',
created_by: 'user-some-long-id',
created_at: '2021-09-28T07:33:05.064629+00:00',
updated_by: null,
updated_at: null
},
relationships: {}
}
],
included: [],
meta: {},
links: { total_items: 1, current_page: 1 }
}Name (string) Tag name Description (string) Optional value for tags used to add additional data regarding a tag
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().create({
name: 'tag name 1',
description: 'Some description'
}).then((response) => {
console.log('*********** Tag create *********');
console.log(response);
});
})();{
data: {
id: 'some-long-id',
type: 'tag',
attributes: {
tag_id: 'some-long-id',
name: 'tag name 1',
description: 'Some description',
organization_id: 'organization-some-long-id',
created_by: 'user-some-long-id',
created_at: '2021-09-28T08:15:12.797516+00:00',
updated_by: null,
updated_at: null
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get details about a specific tag.
Tag Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().retrieveId('some-long-id').then((response) => {
console.log('*********** Tag retrieve by id *********');
console.log(response.data);
});
})();// *********** Tag retrieve by id *********
{
id: 'some-long-id',
type: 'tag',
attributes: {
created_at: '2021-09-28T08:15:12.797516+00:00',
updated_at: null,
tag_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'tag name 1',
description: 'Some description',
created_by: 'user-some-long-id',
updated_by: null
},
relationships: {}
}Get details about a specific tag.
Tag Id* (string)* required parameter
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().retrieve('some-long-id').then((response) => {
console.log('*********** Tag retrieve *********');
console.log(response.data);
});
})();*********** Tag retrieve *********
{
id: 'some-long-id',
type: 'tag',
attributes: {
created_at: '2021-09-28T08:15:12.797516+00:00',
updated_at: null,
tag_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'tag name 1',
description: 'Some description',
created_by: 'user-some-long-id',
updated_by: null
},
relationships: {}
}Update details about a specific tag.
Tag Id* (string)* required parameter Document link
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().update({
id: 'some-long-id',
name: 'New tag name',
description: 'Some long description'
}).then((response) => {
// save this tag id to edit the same tag
tag_id = response.data.attributes.tag_id;
console.log('*********** Tag updated *********');
console.log(response);
});
})();// *********** Tag updated *********
{
data: {
id: 'some-long-id',
type: 'tag',
attributes: {
created_at: '2021-09-28T08:15:12.797516+00:00',
updated_at: '2021-09-28T08:27:19.940023+00:00',
tag_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'New tag name',
description: 'Some long description',
created_by: 'user-some-long-id',
updated_by: 'user-some-long-id'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Delete a specific tag.
Tag Id* (string)* required parameter Document link
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Tags().remove('some-long-id').then((response) => {
// save this tag id to edit the same tag
tag_id = response.data.attributes.tag_id;
console.log('*********** Tag remove *********');
console.log(response);
});
})();// *********** Tag remove *********
{
data: {
id: 'some-long-id',
type: 'tag',
attributes: {
created_at: '2021-09-28T08:15:12.797516+00:00',
updated_at: '2021-09-28T08:27:19.940023+00:00',
tag_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'New tag name',
description: 'Some long description',
created_by: 'user-some-long-id',
updated_by: 'user-some-long-id'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}List all of your organization's prompts.
Query String Parameters
- page - The page of records to return. Optional, defaults to page 1.
- size - the number of records to return for each page. Optional, defaults to 20 - prompts a page.
- schema_class - not used, exclude.
- tags - A list of Tag IDs separated by comma used to filter the results, optional.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
await mantiumAi.Prompts().list({ 'page': 1, 'size': 20, 'show_public_shareable': false }).then((response) => {
console.log('*********** List *********');
console.log(response.data);
});
})();{
data: [
{
id: 'some-long-id',
type: 'prompt',
attributes: {
prompt_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'Basic Prompt',
description: 'Basic Prompt Description',
created_at: '2021-09-29T02:54:28.543648+00:00',
prompt_text: 'Endpoint Settings: Prompt Line',
share_scope: 'ORGANIZATION_ONLY',
ai_provider_approved: false,
adults_only: false,
ai_method: 'completion',
ai_provider: 'OpenAI',
intelets: [
],
default_engine: 'ada',
status: 'ACTIVE',
prompt_parameters: [
{
prompt_text: 'Endpoint Settings: Prompt Line',
basic_settings: {
top_p: '1',
stop_seq: [
'Basic Settings: Stop Sequence'
],
max_tokens: '1024',
temperature: '1',
presence_penalty: '1',
frequency_penalty: '1'
},
default_engine: 'ada',
advanced_settings: {
n: '1',
echo: true,
stream: true,
best_of: '10',
logprobs: '10',
logit_bias: [
]
}
}
],
last_activity: null,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_allow_input: false,
share_status: 'ACTIVE'
},
relationships: {
intelets: { data: [ ] },
tags: {
data: [
{
type: 'tag',
id: 'tag-some-long-id'
}
]
},
security_policies: { data: [ ] },
prompt_policies: { data: [ ] }
}
}
],
included: [
{
id: 'tag-some-long-id',
type: 'tag',
attributes: [
{ tag_id: 'tag-some-long-id', name: 'Basic Tag' }
],
relationships: {
}
}
],
meta: {
},
links: {
total_items: 3,
current_page: 1
}
}Body payload
object { ...data }; Object example
in following example we send number beyond the number range
prompt_parameters.advanced_settings.n = 10
this value should between 1 - 3
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
mantiumAi.Prompts('OpenAI').create({
"name": "create the Prompt",
"intelets": [],
"policies": [],
"tags": ["tag-some-long-id"],
"status": "ACTIVE",
"description": "Basic Prompt Description",
"prompt_text": "Endpoint Settings: Prompt Line",
"ai_method": "completion",
"default_engine": "ada",
"prompt_parameters": {
"basic_settings": {
"temperature": "1",
"max_tokens": "512",
"frequency_penalty": "1",
"presence_penalty": "1",
"top_p": "1",
"stop_seq": ["Basic Settings: Stop Sequence"]
},
"advanced_settings": {
"best_of": "5",
"n": "10",
"logprobs": "10",
"echo": true,
"stream": true,
"logit_bias": []
}
}
}).then((response) => {
console.log("*************** Prompt Create ***************");
console.log(response.detail);
});
})();// *************** Prompt Create ***************
{
detail: [
{
loc: [ 'body', 'prompt_parameters', 'advanced_settings', 'n' ],
msg: 'ensure this value is less than or equal to 3',
type: 'value_error.number.not_le',
ctx: { limit_value: 3 }
}
]
}// *************** Prompt Create ***************
{
data: {
id: 'some-long-id',
type: 'prompt',
attributes: {
prompt_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'create the Prompt',
description: 'Basic Prompt Description',
created_at: '2021-10-10T15:28:29.026463+00:00',
prompt_text: 'Endpoint Settings: Prompt Line',
share_scope: 'ORGANIZATION_ONLY',
ai_provider_approved: false,
adults_only: false,
ai_method: 'completion',
ai_provider: 'OpenAI',
default_engine: 'ada',
status: 'ACTIVE',
prompt_parameters: [Object],
last_activity: null,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_allow_input: false,
share_status: 'ACTIVE'
},
relationships: {
intelets: [Object],
tags: [Object],
security_policies: [Object],
prompt_policies: [Object]
}
},
included: [
{
id: 'tag-some-long-id',
type: 'tag',
attributes: [Object],
relationships: {}
}
],
meta: {},
links: {}
}Update details about a specific Prompt.
Prompt Id* (string)* required parameter
Body payload object { ...data }; Object example
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
// console.log(response);
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
mantiumAi.Prompts('OpenAI').update({
"id": "some-long-id",
"name": "update the Prompt",
"intelets": [],
"policies": [],
"tags": ["383fb5e6-6c30-4641-9850-efeb3cdd77b8"],
"status": "ACTIVE",
"description": "Basic Prompt Description",
"prompt_text": "Endpoint Settings: Prompt Line",
"ai_method": "completion",
"default_engine": "ada",
"prompt_parameters": {
"basic_settings": {
"temperature": "1",
"max_tokens": "512",
"frequency_penalty": "1",
"presence_penalty": "1",
"top_p": "1",
"stop_seq": ["Basic Settings: Stop Sequence"]
},
"advanced_settings": {
"best_of": "5",
"n": "2",
"logprobs": "10",
"echo": true,
"stream": true,
"logit_bias": []
}
}
}).then((response) => {
console.log("*************** Prompt Update ***************");
console.log(response);
});
})();// *************** Prompt Update ***************
{
data: {
id: 'some-long-id',
type: 'prompt',
attributes: {
prompt_id: 'some-long-id',
organization_id: 'organization-some-long-id',
name: 'update the Prompt',
description: 'Basic Prompt Description',
created_at: '2021-10-10T15:28:29.026463+00:00',
prompt_text: 'Endpoint Settings: Prompt Line',
share_scope: 'ORGANIZATION_ONLY',
ai_provider_approved: false,
adults_only: false,
ai_method: 'completion',
ai_provider: 'OpenAI',
default_engine: 'ada',
status: 'ACTIVE',
prompt_parameters: {
basic_settings: {
top_p: '1',
stop_seq: [Array],
max_tokens: '512',
temperature: '1',
presence_penalty: '1',
frequency_penalty: '1'
},
advanced_settings: {
n: '2',
echo: true,
stream: true,
best_of: '5',
logprobs: '10',
logit_bias: []
}
},
last_activity: null,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_allow_input: false,
share_status: 'ACTIVE'
},
relationships: {
intelets: { data: [] },
tags: { data: [ [Object] ] },
security_policies: { data: [] },
prompt_policies: { data: [] }
}
},
included: [
{
id: 'tag-some-long-id',
type: 'tag',
attributes: {
tag_id: 'tag-some-long-id',
name: 'Basic Tag'
},
relationships: {}
}
],
meta: {},
links: {}
}Get details about a specific Prompt.
Prompt Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Prompts()
.retreiveId('fab6e007-dab2-4245-907e-e1edf6f5f690')
.then((response) => {
console.log("*************** Retreive ***************");
console.log(response);
});
})();{
data: {
id: 'fab6e007-dab2-4245-907e-e1edf6f5f690',
type: 'prompt',
attributes: {
prompt_id: 'fab6e007-dab2-4245-907e-e1edf6f5f690',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'update the Prompt',
description: 'Basic Prompt Description',
created_at: '2021-10-10T15:28:29.026463+00:00',
prompt_text: 'Endpoint Settings: Prompt Line',
share_scope: 'ORGANIZATION_ONLY',
ai_provider_approved: false,
adults_only: false,
ai_method: 'completion',
ai_provider: 'OpenAI',
default_engine: 'ada',
status: 'ACTIVE',
prompt_parameters: {
basic_settings: {
top_p: '1',
stop_seq: [Array],
max_tokens: '512',
temperature: '1',
presence_penalty: '1',
frequency_penalty: '1'
},
advanced_settings: {
n: '2',
echo: true,
stream: true,
best_of: '5',
logprobs: '10',
logit_bias: []
}
},
last_activity: null,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_allow_input: false,
share_status: 'ACTIVE'
},
relationships: {
intelets: { data: [] },
tags: { data: [ [Object] ] },
security_policies: { data: [] },
prompt_policies: { data: [] }
}
},
included: [
{
id: '383fb5e6-6c30-4641-9850-efeb3cdd77b8',
type: 'tag',
attributes: {
tag_id: '383fb5e6-6c30-4641-9850-efeb3cdd77b8',
name: 'Basic Tag'
},
relationships: {}
}
],
meta: {},
links: {}
}Get details about a specific Prompt.
Prompt Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Prompts()
.retreive('fab6e007-dab2-4245-907e-e1edf6f5f690')
.then((response) => {
console.log("*************** Retreive ***************");
console.log(response);
});
})();{
data: {
id: 'fab6e007-dab2-4245-907e-e1edf6f5f690',
type: 'prompt',
attributes: {
prompt_id: 'fab6e007-dab2-4245-907e-e1edf6f5f690',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'update the Prompt',
description: 'Basic Prompt Description',
created_at: '2021-10-10T15:28:29.026463+00:00',
prompt_text: 'Endpoint Settings: Prompt Line',
share_scope: 'ORGANIZATION_ONLY',
ai_provider_approved: false,
adults_only: false,
ai_method: 'completion',
ai_provider: 'OpenAI',
default_engine: 'ada',
status: 'ACTIVE',
prompt_parameters: {
basic_settings: {
top_p: '1',
stop_seq: [Array],
max_tokens: '512',
temperature: '1',
presence_penalty: '1',
frequency_penalty: '1'
},
advanced_settings: {
n: '2',
echo: true,
stream: true,
best_of: '5',
logprobs: '10',
logit_bias: []
}
},
last_activity: null,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_allow_input: false,
share_status: 'ACTIVE'
},
relationships: {
intelets: { data: [] },
tags: { data: [ [Object] ] },
security_policies: { data: [] },
prompt_policies: { data: [] }
}
},
included: [
{
id: '383fb5e6-6c30-4641-9850-efeb3cdd77b8',
type: 'tag',
attributes: {
tag_id: '383fb5e6-6c30-4641-9850-efeb3cdd77b8',
name: 'Basic Tag'
},
relationships: {}
}
],
meta: {},
links: {}
}Delete a specific Prompt.
Prompt Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Prompts()
.remove('fab6e007-dab2-4245-907e-e1edf6f5f690')
.then((response) => {
console.log("*************** Remove ***************");
console.log(response);
});
})();
/*
* run command
* node prompt/retreive.js
*/{}Asynchronously submit a prompt by prompt_id. If successful, the status and results of the prompt can be retrieved from the /v1/prompt/result/{prompt_execution_id} endpoint by prompt_execution_id.
Prompt Id* (string)* required parameter
Input* (string)* Input for executing a prompt asynchronously
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
let prompt_id = 'b1c01f1a-ff6c-45e8-8378-d23d11d7de9c';
let input = 'This is my first test execute prompt';
await mantiumAi.Prompts('OpenAI')
.execute({
id: prompt_id,
input
})
.then(async (res) => {
console.log("*************** Execute ***************");
console.log(res);
});
})();// *************** Execute ***************
{
success: true,
prompt_id: 'b1c01f1a-ff6c-45e8-8378-d23d11d7de9c',
input: 'This is my first test execute prompt',
status: 'QUEUED',
prompt_execution_id: 'd96d6f42-05a3-4ae6-b846-a891af8a8635',
error: '',
warning_message: ''
}Returns execution status of a prompt ran through the prompt execution workflow asynchronously.
Prompt Execution Id* (string)* this can be achieved from the successful response from the execute prompt method.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
let prompt_id = 'b1c01f1a-ff6c-45e8-8378-d23d11d7de9c';
let input = 'This is my second test execute prompt';
await mantiumAi.Prompts('OpenAI')
.execute({
id: prompt_id,
input
})
.then(async (res) => {
/*
* from the successful response collect the prompt_execution_id
* and then pass this to the result method
*/
if(res?.prompt_execution_id) {
await mantiumAi.Prompts('OpenAI').result(res.prompt_execution_id)
.then((response) => {
console.log("*************** Execute Result ***************");
console.log(response);
});
}
});
})();// *************** Execute Result ***************
{
prompt_execution_id: 'd96d6f42-05a3-4ae6-b846-a891af8a8635',
prompt_id: 'b1c01f1a-ff6c-45e8-8378-d23d11d7de9c',
status: 'COMPLETED',
input: 'This is my second test execute prompt',
output: "Endpoint Settings: Prompt LineThis is my second test execute prompt, but my last one worked fine. I thought this was rough except for Thoughtnet having doubts about working with it... I found another test which showed interaction with the NavigatorHelpers class. But, now my memory is terrible. Part of that may be hardware ghosting or at least faulty programming on bad servers.....I tried to use InsertPageName here only to find that didn't work though. So, if extra query pages fail because not everything's Showed in Page Name window, something cleantly isn't done.... Now the question is whether Thoughtnet will comply so they don't have to deal w/ weird loading times?????Edit: You can go straight off After powering up after this screen appearsoted by Admin using Command Prompt",
error: '',
reason: '',
hitl_info: null,
warning_message: ''
}Query Params
page (number) - Page number
size (number) - Page size. If not supplied, returns all the results in a single page for certain APIs.
after_date (string) - After Date
before_date (string) Before Date
log_type (string) LogType, An enumeration. [AUTH | DEFAULT | PROMPT | INTELET FILE]
log_level (string) Log Level
log_status (string) Log Status
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Logs().list({
'page': 1,
'size': 2
})
.then((response) => {
console.log('*********** Logs list *********');
console.log(response);
});
})();// *********** Logs list *********
{
data: [
{
id: 'log-some-long-id',
type: 'log',
attributes: {
log_id: 'log-some-long-id',
event_timestamp: '2021-10-15T13:55:57.468749+00:00',
organization_id: 'organization-some-long-id',
log_type: 'PROMPT',
log_payload: [Object],
log_level: 'INFO'
},
relationships: {}
},
{
id: 'log-some-long-id',
type: 'log',
attributes: {
log_id: 'log-some-long-id',
event_timestamp: '2021-10-15T13:55:52.304732+00:00',
organization_id: 'organization-some-long-id',
log_type: 'PROMPT',
log_payload: [Object],
log_level: 'WARNING'
},
relationships: {}
}
],
included: [],
meta: {},
links: { total_items: 103, current_page: 1, next_page: 2 }
}Get details about a specific log.
Prompt Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Logs().retrieveId('log-some-long-id')
.then((response) => {
console.log('*********** Log *********');
console.log(response);
});
})();{
data: {
id: 'bb65e751-9384-4239-a9e9-a29703e94de4',
type: 'log',
attributes: {
log_id: 'bb65e751-9384-4239-a9e9-a29703e94de4',
event_timestamp: '2021-10-15T13:55:57.468749+00:00',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
log_type: 'PROMPT',
log_payload: {
to: 'completion',
name: 'update the Prompt',
error: '',
input: 'This is my testing execute prompt',
config: [Object],
output: '. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test.\n' +
'I have a new prompt line that I want to test.',
status: 'COMPLETED',
ai_app_id: null,
ai_method: 'completion',
direction: 'incoming',
prompt_id: '29d46e2b-9d43-42cf-a1b0-edbf5db745dc',
intelet_id: null,
ai_provider: 'OpenAI',
prompt_text: 'Updated new Prompt Line',
warning_message: null,
provider_response: [Object],
input_character_length: 56
},
log_level: 'INFO'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get details about a specific log.
Prompt Id* (string)* required parameter
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Logs().retrieveId('log-some-long-id')
.then((response) => {
console.log('*********** Log *********');
console.log(response);
});
})();{
data: {
id: 'bb65e751-9384-4239-a9e9-a29703e94de4',
type: 'log',
attributes: {
log_id: 'bb65e751-9384-4239-a9e9-a29703e94de4',
event_timestamp: '2021-10-15T13:55:57.468749+00:00',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
log_type: 'PROMPT',
log_payload: {
to: 'completion',
name: 'update the Prompt',
error: '',
input: 'This is my testing execute prompt',
config: [Object],
output: '. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test. I have a new prompt line that I want to test.\n' +
'I have a new prompt line that I want to test.',
status: 'COMPLETED',
ai_app_id: null,
ai_method: 'completion',
direction: 'incoming',
prompt_id: '29d46e2b-9d43-42cf-a1b0-edbf5db745dc',
intelet_id: null,
ai_provider: 'OpenAI',
prompt_text: 'Updated new Prompt Line',
warning_message: null,
provider_response: [Object],
input_character_length: 56
},
log_level: 'INFO'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}List all of your organization's intelets.
Query String Parameters
-
page (number) - The page of records to return. Optional, defaults to page 1.
-
size (number) - the number of records to return for each page. Optional, defaults to 20 intelets a page.
-
tags (string) - A list of Tag IDs separated by comma used to filter the results, optional.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Intelets().list({ 'page': 1, 'size': 20 }).then((response) => {
console.log('*********** List *********');
console.log(response.data);
});
})();{
data: [
{
id: 'f6e84a80-5c60-4015-90e8-21fe0b0fc8b7',
type: 'intelet_view',
attributes: {
intelet_id: 'f6e84a80-5c60-4015-90e8-21fe0b0fc8b7',
name: 'Intelet Name given by me',
description: 'Description given by me',
created_at: '2021-10-17T10:44:14.510931+00:00',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
created_by_email: 'kedman1234@gmail.com',
created_by_name: ' ',
updated_at: null,
updated_by_email: null,
updated_by_name: null,
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
tags: null,
prompts: [
{
prompt_id: 'c45bcc94-ea1e-4faa-886b-059b10c38020',
prompt_name: 'update the Prompt',
operation_order: 1
},
{
prompt_id: '242bb0a2-213e-4001-96a4-f29e0912c99a',
prompt_name: 'Basic Prompt',
operation_order: 2
}
]
},
relationships: {}
}
],
included: [],
meta: {},
links: { total_items: 1, current_page: 1 }
}-
Name* (string) - Name of the Intelet.
-
Description (string) - Text to describe the purpose of this Intelet.
-
Prompts (array) - Prompts to include in the Intelet. Prompts are executed in the order that they appear in this list, with the first Prompt feeding its output to the 2nd Prompt, and so on until the final Prompt.
Body payload object { ...data }; Object example
in following example we send wrong prompts ID's
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
mantiumAi.Intelets('OpenAI').create({
"name":"intelet name",
"description":"description for the intelet",
"prompts":[
"41f62edf-9b0f-4397-8254-21dfc95e4efe",
"23c217b8-1f87-4222-9e3c-e3bf4497c217"
]}).then((response) => {
console.log("*************** Intelet Create ***************");
console.log(response);
});
})();// *************** Prompt Create ***************
{
detail: 'Prompt ID 96613f72-0fed-4b39-8775-beafe74d30ef does not exist for the organization 563821cd-903e-4b5c-8541-ea828058aec6'
}const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
mantiumAi.Intelets('OpenAI').create({
"name":"intelet name",
"description":"description for the intelet",
"prompts":[
"41f62edf-9b0f-4397-8254-21dfc95e4efe",
"23c217b8-1f87-4222-9e3c-e3bf4497c217"
]}).then((response) => {
console.log("*************** Intelet Create ***************");
console.log(response);
});
})();{
data: {
id: '8caa02c8-cb62-4a58-a17c-302a8369b3a0',
type: 'intelet',
attributes: {
created_at: '2021-10-17T17:18:39.618524+00:00',
updated_at: null,
intelet_id: '8caa02c8-cb62-4a58-a17c-302a8369b3a0',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'intelet name',
description: 'description for the intelet',
share_allow_input: false,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_status: 'ACTIVE',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
updated_by: null
},
relationships: {}
},
included: [],
meta: {},
links: {}
}-
Name* (string) - Name of the Intelet.
-
Description (string) - Text to describe the purpose of this Intelet.
-
Prompts (array) - Prompts to include in the Intelet. Prompts are executed in the order that they appear in this list, with the first Prompt feeding its output to the 2nd Prompt, and so on until the final Prompt.
Prompt Id* (string)* required parameter
Body payload object { ...data }; Object example
const mantiumAi = require('@mantium/mantiumapi');
// mantiumAi.ORIGIN = 'https://api.staging.mantiumai.com';
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
// console.log(response);
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
mantiumAi.Intelets().update({
"id": "5407866a-0ad3-4671-b7e3-b5635bf521ea",
"name":"Chang in intelet name",
"description":"description for the intelet is changed",
"prompts":[
"41f62edf-9b0f-4397-8254-21dfc95e4efe",
"23c217b8-1f87-4222-9e3c-e3bf4497c217"
]}).then((response) => {
console.log("*************** Intelet update ***************");
console.log(response);
});
})();// *************** Intelet Update ***************
{
data: {
id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
type: 'intelet',
attributes: {
created_at: '2021-10-18T10:25:08.034662+00:00',
updated_at: '2021-10-18T10:42:57.048906+00:00',
intelet_id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'Chang in intelet name',
description: 'description for the intelet is changed',
share_allow_input: false,
share_name: null,
share_description: '',
share_placeholder: '',
share_author_name: null,
share_author_contact: '',
share_type: null,
share_status: 'ACTIVE',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
updated_by: 'a3e5c076-311c-46af-97cd-d1e529512afe'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Information on specific intelet
- Intelet Id* (string)
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Intelets()
.retrieveId('5407866a-0ad3-4671-b7e3-b5635bf521ea')
.then((response) => {
console.log("*************** retrieve ***************");
console.log(response);
});
})();// *************** retrieve ***************
{
data: {
id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
type: 'intelet_view',
attributes: {
intelet_id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
name: 'Chang in intelet name',
description: 'description for the intelet is changed',
created_at: '2021-10-18T10:25:08.034662+00:00',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
created_by_email: 'kedman1234@gmail.com',
created_by_name: ' ',
updated_at: '2021-10-18T10:42:57.048906+00:00',
updated_by_email: 'kedman1234@gmail.com',
updated_by_name: ' ',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
tags: null,
prompts: [
{
prompt_id: 'c07449be-aae0-421c-a00d-72e1b6928ac4',
prompt_name: 'update the Prompt',
operation_order: 1
},
{
prompt_id: 'fb6a24b9-cd3c-4600-a58f-929ce6d5c044',
prompt_name: 'Test prompt name',
operation_order: 2
}
]
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Information on specific intelet
- Intelet Id* (string)
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Intelets()
.retrieve('5407866a-0ad3-4671-b7e3-b5635bf521ea')
.then((response) => {
console.log("*************** retrieve ***************");
console.log(response);
});
})();// *************** retrieve ***************
{
data: {
id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
type: 'intelet_view',
attributes: {
intelet_id: '5407866a-0ad3-4671-b7e3-b5635bf521ea',
name: 'Chang in intelet name',
description: 'description for the intelet is changed',
created_at: '2021-10-18T10:25:08.034662+00:00',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
created_by_email: 'kedman1234@gmail.com',
created_by_name: ' ',
updated_at: '2021-10-18T10:42:57.048906+00:00',
updated_by_email: 'kedman1234@gmail.com',
updated_by_name: ' ',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
tags: null,
prompts: [
{
prompt_id: 'c07449be-aae0-421c-a00d-72e1b6928ac4',
prompt_name: 'update the Prompt',
operation_order: 1
},
{
prompt_id: 'fb6a24b9-cd3c-4600-a58f-929ce6d5c044',
prompt_name: 'Test prompt name',
operation_order: 2
}
]
},
relationships: {}
},
included: [],
meta: {},
links: {}
}- Intelet Id* (string)
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi.Intelets()
.remove('2bddef3e-f4d9-400c-b2db-4ed2a52c6b83')
.then((response) => {
console.log("*************** Remove ***************");
console.log(response);
});
})();
/*
* run command
* node intelets/remove.js
*/Intelet DeletedAsynchronously submit data to an intelet by intelet_id. If successful, the status and results of the intelet can be retrieved from the /v1/intelet/result/{intelet_execution_id} endpoint by intelet_execution_id.
Intelet Id* (string)* required parameter, The ID of the intelet to start executing
Input* (string)* Data to input into the Intelet
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
let intelet_id = 'some-long-intelets-id';
let input = 'What is the meaning of life?';
await mantiumAi.Intelets()
.execute({
id: intelet_id,
input
})
.then(async (res) => {
console.log("*************** Execute ***************");
console.log(res);
});
})();// *************** Execute ***************
{
success: true,
intelet_id: 'some-long-intelets-id',
input: 'What is the meaning of life?',
status: 'QUEUED',
intelet_execution_id: 'some-long-intelets-execution-id',
error: ''
}Get Intelet Execution Result
Returns execution status of intelet ran through the intelet execution workflow asynchronously.
Intelet Execution Id* (string)* this can be achieved from the successful response from the execute Intelet method.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
let intelet_id = 'some-long-intelets-id';
let input = 'What is the meaning of life?';
await mantiumAi.Intelets()
.execute({
id: intelet_id,
input
})
.then(async (res) => {
/*
* from the successful response collect the prompt_execution_id
* and then pass this to the result method
*/
if(res?.intelet_execution_id) {
await mantiumAi.Intelets().result(res.intelet_execution_id)
.then((response) => {
console.log("*************** Execute Result ***************");
console.log(response);
});
}
});
})();// *************** Execute Result ***************
{
intelet_execution_id: '81daa784-838f-46f6-9518-2c50cec7fb4b',
intelet_id: 'da98c9fc-c139-4136-a6e9-286bca5cc397',
status: 'COMPLETED',
input: 'What is the meaning of life?',
output: '\n' +
'"I am a man of the people, and I will not be a slave to the people." - Abraham Lincoln\n' +
'\n',
error: '',
reason: '',
results: [],
pending_prompts: [],
executed_prompts: [
{
status: 'COMPLETED',
prompt_execution_id: '4e72c6a3-3560-410c-af5f-fe5544d5b986',
prompt_id: '41f62edf-9b0f-4397-8254-21dfc95e4efe',
input: 'What is the meaning of life?',
output: '\n' +
'Check out my FULL explanation, including copyright claim for this work at the bottom of the OP.\n' +
"Well is it absolutely necessary? I know you like to troll, but if your goal is information sharing (and not trolling) is there any point in starting with negativity? Or am I missing something that using fault finding opens up exept personal gratification on your part..OH PS IM NOT A TANK!!!! Well many people may respond 'TKO's SILLY' Check out my FULL explanation, including copyright claim for this work at the bottom of the OP.Well is it absolutely necessary? I know you like to troll, but if your goal is information sharing (and not trolling)is there any point in starting with negativity? Or am I missing something that using fault finding opens up exept personal gratification on your part..OH PS IM NOT A TANK!!!!",
reason: '',
error: '',
hitl_info: null
},
{
status: 'COMPLETED',
prompt_execution_id: '8108d3be-0f12-4d94-bfda-1f49327c6d12',
prompt_id: '23c217b8-1f87-4222-9e3c-e3bf4497c217',
input: '\n' +
'Check out my FULL explanation, including copyright claim for this work at the bottom of the OP.\n' +
"Well is it absolutely necessary? I know you like to troll, but if your goal is information sharing (and not trolling) is there any point in starting with negativity? Or am I missing something that using fault finding opens up exept personal gratification on your part..OH PS IM NOT A TANK!!!! Well many people may respond 'TKO's SILLY' Check out my FULL explanation, including copyright claim for this work at the bottom of the OP.Well is it absolutely necessary? I know you like to troll, but if your goal is information sharing (and not trolling)is there any point in starting with negativity? Or am I missing something that using fault finding opens up exept personal gratification on your part..OH PS IM NOT A TANK!!!!",
output: '\n' +
'"I am a man of the people, and I will not be a slave to the people." - Abraham Lincoln\n' +
'\n',
reason: '',
error: '',
hitl_info: null
}
]
}Check the API health.
const mantiumAi = require('@mantium/mantiumapi');
mantiumAi.Health().check().then((response) => {
console.log("*************** Health response ***************");
console.log(response);
});OK. API Version vX-XXXXXXXX running since YYYY-MM-DDTHH:MM:SS+00:00.Get the list of files currently loaded at OpenAI
Requirements:
QUERY PARAMS
file_type (string) 'FILES_ONLY' or 'ALL' or 'FINETUNE_ONLY'
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi
.Auth()
.accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Files()
.list({ file_type: 'FILES_ONLY' })
.then((response) => {
console.log('*********** File list *********');
console.log(response);
});
})();
{
data: {
id: 'user-fakpcmfytnzhd7s7uwvzrbms',
type: 'openai_file',
attributes: {
organization: 'user-fakpcmfytnzhd7s7uwvzrbms',
files: [
{
id: 'file-lD7g3egNlil5yyg1RaAkQlmW',
object: 'file',
bytes: 1129,
created_at: 1623106510,
filename: 'sam2.json',
purpose: 'answers',
status: 'processed',
status_details: null
},
{
id: 'file-MiwAljthEIAh0WnqVKyNm2HU',
object: 'file',
bytes: 1128,
created_at: 1624554610,
filename: 'blob',
purpose: 'answers',
status: 'processed',
status_details: null
},
{
id: 'file-nkuxoRXPWw6Tl12C0xkheNpb',
object: 'file',
bytes: 1131,
created_at: 1624580768,
filename: 'blob',
purpose: 'answers',
status: 'error',
status_details: 'Something went wrong while processing. Please contact support@openai.com with the file ID file-nkuxoRXPWw6Tl12C0xkheNpb'
}
],
size: 3
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Upload a file to AWS
key (string) The AWS key name (or filename)
purpose (string) OpenAI file purpose, it could be one of the following answers, classifications or search
upload_source* (string)* required parameter - The upload source, which could be one of OPENAI-FILE-UPLOAD or OPENAI-FINETUNING-UPLOAD
fine_tune_file_type (string) - Could be either VALIDATION_FILE or TRAINING_FILE
const mantiumAi = require('@mantium/mantiumapi');
const fs = require('fs');
(async () => {
await mantiumAi
.Auth()
.accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Files()
.upload({
purpose: 'Classifications',
key: fs.createReadStream('./files/classifications_test_file.json'),
upload_source: 'OPENAI-FILE-UPLOAD',
fine_tune_file_type: '',
})
.then((response) => {
console.log('*********** Upload response *********');
console.log(response);
});
})();{
success: true,
status: 200,
error: '',
warning_message: '',
upload_source: 'OPENAI-FILE-UPLOAD',
fine_tune_file_type: '',
path: './files/classifications_test_file.json',
purpose: 'Classifications'
}file_id* (string)* required parameter - file id to delete
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi
.Auth()
.accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Files()
.remove('file-lD7g3egNlil5yyg1RaAkQlmW')
.then((response) => {
console.log('*********** Remove response *********');
console.log(response);
});
})();{
data: {
id: 'file-lD7g3egNlil5yyg1RaAkQlmW',
type: 'openai_file',
attributes: {
deleted: true,
file_id: 'file-lD7g3egNlil5yyg1RaAkQlmW',
object: 'file'
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Security Policies You can manage your security policies using these methods.
Create a Security Policy. We only create one policy at a time.
There is no need to support posting a list of polices at once
Requirements:
name* (string) required parameter, The name of the security policy.
description (string) A description of this security policy.
rules (array) A list of JSON rules objects to attach to the policy.
notifications (array) A list of Notifications to send when any one of the rules are violated.
actions (array) A list of Security Actions to take when any one of the rules are violated.
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.createPolicy({
name: 'must be policyname new',
description: '',
rules: [
{
rule_id: '8bc66446-c72d-4627-a3f4-cf942383cee5',
parameters: {
max_input_characters: '2',
scope: 'per_prompt',
},
},
],
actions: [
{
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40',
},
{
action_type_id: 'a49e30e3-da97-49a1-b501-7840358825ba',
},
{
action_type_id: '72d64ca0-35bf-4646-9782-90634d7b6b97',
},
],
notifications: [],
})
.then((response) => {
console.log('*********** policy create *********');
console.log(response);
});
})();{
data: [
{
attributes: {
created_at: '2022-01-14T15:06:21.705558+00:00',
updated_at: null,
policy_id: '7510e70c-c5d8-40b0-b150-0773fccff757',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'must be policyname new',
description: '',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
updated_by: null,
rules: [
{
rule_id: '8bc66446-c72d-4627-a3f4-cf942383cee5',
parameters: [Object]
}
],
actions: [
{
action_id: 'e171e6eb-cee2-4fb7-b5bc-ecdb62b2b654',
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40'
},
{
action_id: '43f509a8-ec09-4221-a188-59037ddb3409',
action_type_id: 'a49e30e3-da97-49a1-b501-7840358825ba'
},
{
action_id: '6711d3cf-b877-4445-bdf4-6010b5b78625',
action_type_id: '72d64ca0-35bf-4646-9782-90634d7b6b97'
}
]
},
relationships: { notifications: { data: [] } },
type: 'security_policy'
}
]
}Update the existing policy with the contents of the payload
The UUID in the path is to specify the Security Policy to be updated
Requirements:
id* (string) required parameter, The policy ID which need to update.
name* (string) required parameter, The name of the security policy.
description (string) A description of this security policy.
rules (array) A list of JSON rules objects to attach to the policy.
notifications (array) A list of Notifications to send when any one of the rules are violated.
actions (array) A list of Security Actions to take when any one of the rules are violated.
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.updatePolicy({
id: 'fbf3383d-4349-425e-84ec-e6831318f08b',
name: 'must be policyname new via update',
description: 'updated descriptions naav change',
rules: [
{
rule_id: '8bc66446-c72d-4627-a3f4-cf942383cee5',
parameters: {
max_input_characters: '2',
scope: 'per_prompt',
},
},
],
actions: [
{
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40',
},
{
action_type_id: 'a49e30e3-da97-49a1-b501-7840358825ba',
},
{
action_type_id: '72d64ca0-35bf-4646-9782-90634d7b6b97',
},
],
notifications: [],
})
.then((response) => {
console.log('*********** policy update *********');
console.log(response);
console.log(response.data[0].attributes);
console.log(response.data[0].relationships);
});
})();{
data: {
attributes: {
created_at: '2022-01-15T18:32:20.703771+00:00',
updated_at: '2022-01-15T19:04:42.606019+00:00',
policy_id: '73067dc6-44dd-472d-a82b-44e0c3a1ea0a',
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
name: 'must be policyname new via update',
description: 'updated descriptions naav change',
created_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
updated_by: 'a3e5c076-311c-46af-97cd-d1e529512afe',
rules: [Array],
actions: [Array]
},
relationships: { notifications: [Object] },
type: 'security_policy'
}
}Deletes an existing policy for an organization
id* (string) required parameter, The policy ID
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.removePolicy('d1851a8b-5735-48be-8fc6-f7aa295df3b4')
.then((response) => {
console.log('*********** removePolicy *********');
console.log(response);
});
})();{
"data": {
"attributes": {
"created_at": "2022-01-15T18:31:42.982544+00:00",
"updated_at": null,
"policy_id": "d1851a8b-5735-48be-8fc6-f7aa295df3b4",
"organization_id": "c68c07c9-d11a-4b54-8823-1dff6792916d",
"name": "must be policyname new",
"description": "",
"created_by": "a3e5c076-311c-46af-97cd-d1e529512afe",
"updated_by": null
},
"type": "security_policy"
}
}Get all of your selected organization's security policies
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
await mantiumAi
.Security()
.listPolicies({ page: 1, size: 2 })
.then((response) => {
console.log('*********** listpolicies response *********');
console.log(response);
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
})();{
data: [
{
id: 'policy_id',
type: 'security_policy',
attributes: [{
id: 'policy_id',
type: 'security_policy',
attributes: {
policy_id: '07af5486-f77c-48c2-9ccf-318c81643736',
name: 'some policyname',
description: 'some description for policy',
rules: [ [Object] ],
actions: [ [Object], [Object], [Object] ],
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
created_by_name: ' ',
created_by_email: 'kedman1234@gmail.com',
updated_by_name: '',
updated_by_email: null
},
relationships: { notifications: { data: [] } }
},
{
id: 'policy_id',
type: 'security_policy',
attributes: {
policy_id: '052059b8-d9e7-4fda-b8c7-13fb02103b4c',
name: 'must be policyname new',
description: '',
rules: [ [Object] ],
actions: [ [Object], [Object], [Object] ],
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
created_by_name: ' ',
created_by_email: 'kedman1234@gmail.com',
updated_by_name: '',
updated_by_email: null
},
relationships: { notifications: { data: [] } }
}],
relationships: [Object]
},
{
id: 'policy_id',
type: 'security_policy',
attributes: [Object],
relationships: [Object]
}
],
included: null,
meta: null,
links: { total_items: 34, current_page: 1, next_page: 2 }
}Get a specific Security Policy for your selected organization
id* (string) required parameter, The policy ID
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.policy('39a17204-aa6c-46c7-ae0c-fe664f6397b0')
.then((response) => {
console.log('*********** policy response *********');
console.log(response);
});
})();{
data: [{
attributes: {
policy_id: '39a17204-aa6c-46c7-ae0c-fe664f6397b0',
name: 'max char 2 policy',
description: 'max char 2 policy',
rules: [Array],
actions: [Array],
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
created_by_name: ' ',
created_by_email: 'kedman1234@gmail.com',
updated_by_name: '',
updated_by_email: null
},
relationships: { notifications: [Object] },
type: 'security_policy',
id: 'policy_id'
}]
}Get a specific Security Policy for your selected organization
id* (string) required parameter, The policy ID
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.policyId('39a17204-aa6c-46c7-ae0c-fe664f6397b0')
.then((response) => {
console.log('*********** retrievePolicy response *********');
console.log(response);
});
})();{
data: [{
attributes: {
policy_id: '39a17204-aa6c-46c7-ae0c-fe664f6397b0',
name: 'max char 2 policy',
description: 'max char 2 policy',
rules: [Array],
actions: [Array],
organization_id: 'c68c07c9-d11a-4b54-8823-1dff6792916d',
organization_name: ' ',
created_by_name: ' ',
created_by_email: 'kedman1234@gmail.com',
updated_by_name: '',
updated_by_email: null
},
relationships: { notifications: [Object] },
type: 'security_policy',
id: 'policy_id'
}]
}List available Security Rules
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.listRules({ page: 1, size: 2 })
.then((response) => {
console.log('*********** listRules response *********');
console.log(response);
});
})();{
data: [
{
id: '0a3e489e-aa59-634b-82bf-c2f81dd67608',
type: 'security_rule',
attributes: [Object],
relationships: {}
},
{
id: '6a8282b9-03d1-4a89-0291-73709998efab',
type: 'security_rule',
attributes: [Object],
relationships: {}
}
],
included: null,
meta: null,
links: { total_items: 15, current_page: 1, next_page: 2 }
}Get a specific Security Rule
id* (string) required parameter, The rule ID
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.rule('0a3e489e-aa59-634b-82bf-c2f81dd67608')
.then((response) => {
console.log('*********** rule response *********');
console.log(response);
});
})();{
data: {
id: '0a3e489e-aa59-634b-82bf-c2f81dd67608',
type: 'security_rule',
attributes: {
rule_id: '0a3e489e-aa59-634b-82bf-c2f81dd67608',
name: 'Ai21 Input Characters',
description: 'Maximum Input Characters for a given prompt',
ai_provider: 'Ai21',
preprocessor: true,
postprocessor: false,
parameter_template: [Array]
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get a specific Security Rule
id* (string) required parameter, The rule ID
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.ruleId('0a3e489e-aa59-634b-82bf-c2f81dd67608')
.then((response) => {
console.log('*********** ruleId response *********');
console.log(response);
});
})();{
data: {
id: '0a3e489e-aa59-634b-82bf-c2f81dd67608',
type: 'security_rule',
attributes: {
rule_id: '0a3e489e-aa59-634b-82bf-c2f81dd67608',
name: 'Ai21 Input Characters',
description: 'Maximum Input Characters for a given prompt',
ai_provider: 'Ai21',
preprocessor: true,
postprocessor: false,
parameter_template: [Array]
},
relationships: {}
},
included: [],
meta: {},
links: {}
}List available Security Action Types
These are added to a Security Policy to tell it what to do after a Security Rule is violated.
Query Params
Page Page number
Size Page size. If not supplied, returns all the results in a single page for certain APIs.
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.listActionTypes({ page: 1, size: 2 })
.then((response) => {
console.log('*********** listActionTypes response *********');
console.log(response);
console.log(response.data);
});
})();{
data: [
{
id: '1e378559-7015-4271-a3f1-abcd2c663c40',
type: 'action_type',
attributes: {
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40',
name: 'Log Warning',
description: 'Record a Warning in the logs',
configurable: false
},
relationships: { parameter_template: [Object] }
},
{
id: 'a49e30e3-da97-49a1-b501-7840358825ba',
type: 'action_type',
attributes: {
action_type_id: 'a49e30e3-da97-49a1-b501-7840358825ba',
name: 'Halt Processing',
description: 'Immediately stop processing the prompt',
configurable: false
},
relationships: { parameter_template: [Object] }
}
],
included: null,
meta: null,
links: { total_items: 5, current_page: 1, next_page: 2 }
}Get a specific Security ActionType
id* (string) required parameter, The action_type_id
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.actionType('1e378559-7015-4271-a3f1-abcd2c663c40')
.then((response) => {
console.log('*********** actionType response *********');
console.log(response);
});
})();{
data: {
id: '1e378559-7015-4271-a3f1-abcd2c663c40',
type: 'action_type',
attributes: {
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40',
name: 'Log Warning',
description: 'Record a Warning in the logs',
configurable: false
},
relationships: { parameter_template: [Object] }
},
included: [],
meta: {},
links: {}
}Get a specific Security ActionType
id* (string) required parameter, The action_type_id
const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.Security()
.actionTypeId('1e378559-7015-4271-a3f1-abcd2c663c40')
.then((response) => {
console.log('*********** actionTypeId response *********');
console.log(response);
});
})();{
data: {
id: '1e378559-7015-4271-a3f1-abcd2c663c40',
type: 'action_type',
attributes: {
action_type_id: '1e378559-7015-4271-a3f1-abcd2c663c40',
name: 'Log Warning',
description: 'Record a Warning in the logs',
configurable: false
},
relationships: { parameter_template: [Object] }
},
included: [],
meta: {},
links: {}
}const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.HITL()
.list({ page: 1, size: 2 })
.then((response) => {
console.log('*********** HITL list response *********');
console.log(response);
});
})();[
{
prompt_id: 'f467db9a-fb96-4353-bb65-63a113d134a1',
prompt_execution_id: '5e0beb8d-e4b4-4ad5-95e6-cd371981fe83',
input: 'Le',
output: 'icester won the last premier league. Is this true?\n' +
'AI: Yes, Leicester City Football Club won the 2015–16 Premier League, defeating pre-match favourites Arsenal 3–1 in the 2016 UEFA Champions League Final \n',
error: '',
status: 'INTERRUPTED',
reason: 'Max Total Characters rule violation: (prompt + input + output) characters > max_total_characters'
},
{
prompt_id: 'f467db9a-fb96-4353-bb65-63a113d134a1',
prompt_execution_id: '7b7c698c-d538-46e6-9a22-7276e754c421',
input: "Writing The Perfect Valentine's Day Card Has Never Been Easier",
output: '. What is the best valentine’s gift for a woman?\n' +
'AI: A necklace. It will let her know that you are thinking of her. Plus, she can wear it and think of you while she is away from you, which will make both of you happy.\n',
error: '',
status: 'INTERRUPTED',
reason: 'Max Total Characters rule violation: (prompt + input + output) characters > max_total_characters'
},
{
prompt_id: 'ea79010c-a641-4282-9719-5ef78f560d24',
prompt_execution_id: '258e7dcc-d463-4699-a756-62593ef6e765',
input: 'This is my testing execute prompt',
output: '',
error: '',
status: 'INTERRUPTED',
reason: 'The total number of input characters (input + prompt) exceeds the limit set in the security rule.'
}
]const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.HITL()
.accept('7c18c7d1-d375-4410-a4a5-fa20c49f1f61')
.then((response) => {
console.log('*********** HITL accept response *********');
console.log(response);
});
})();{
prompt_id: 'a4965b19-94e6-4c12-b1f7-2048708e6f53',
prompt_execution_id: '7c18c7d1-d375-4410-a4a5-fa20c49f1f61',
input: 'This is my testing execute prompt',
output: '',
error: '',
status: 'QUEUED',
reason: 'The total number of input characters (input + prompt) exceeds the limit set in the security rule.'
}const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.HITL()
.reject('a18e5887-3ed0-42b9-a9b5-b0fda4797b84')
.then((response) => {
console.log('*********** HITL reject response *********');
console.log(response);
});
})();{
prompt_id: 'a708ddf6-f813-4d63-9e71-2fdfd6bbcf31',
prompt_execution_id: '3b547055-3edc-4cc5-9afe-bea7c4ddc53c',
input: 'This is my testing execute prompt',
output: '',
error: '',
status: 'REJECTED',
reason: 'The total number of input characters (input + prompt) exceeds the limit set in the security rule.'
}const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.HITL()
.modifyOutput({
id: '4ccda50e-5757-49f2-a180-367bbf3a0cae',
new_output: 'The black book is on left',
})
.then((response) => {
console.log('*********** HITL modify output response *********');
console.log(response);
});
})();{
prompt_id: 'dacef118-4ebf-4242-b646-b4f88d71a1a0',
prompt_execution_id: '4ccda50e-5757-49f2-a180-367bbf3a0cae',
input: 'This is my testing execute prompt',
output: 'The black book is on left',
error: '',
status: 'COMPLETED',
reason: 'The total number of input characters (input + prompt) exceeds the limit set in the security rule.'
}const mantiumAi = require('mantiumclient-js');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.HITL()
.modifyInput({
id: 'a0e56fee-b338-40a0-810f-a40031eb2bcd',
new_input: 'Le',
})
.then((response) => {
console.log('*********** HITL modify input response *********');
console.log(response);
});
})();{
prompt_id: 'eb67691d-d4ac-4b81-9b69-fcc1cd09df3f',
prompt_execution_id: 'a0e56fee-b338-40a0-810f-a40031eb2bcd',
input: 'Le',
output: '',
error: '',
status: 'QUEUED',
reason: 'The total number of input characters (input + prompt) exceeds the limit set in the security rule.'
}Managing the API keys of your selected organization.
Get a summary of the api keys your selected organization currently has configured.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.ProviderIntegrations()
.list({ page: 1, size: 2 })
.then((response) => {
console.log('*********** Provider Integrations list response *********');
console.log(response.data);
console.log(response.data[0].attributes);
});
})();*********** Provider Integrations list response *********
{
data: [
{
id: 'Cohere',
type: 'api_key',
{
ai_provider: 'Cohere',
verified: true,
created: {
timestamp: '2021-12-30T06:25:37.444072+00:00',
user_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
full_name: ' ',
email: 'user@emai.com'
},
updated: null
},
relationships: {}
},
{
id: 'OpenAI',
type: 'api_key',
{
ai_provider: 'OpenAI',
verified: true,
created: {
timestamp: '2022-05-29T12:18:11.014818+00:00',
user_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
full_name: ' ',
email: 'user@emai.com'
},
updated: null
},
relationships: {}
}
],
included: [],
meta: {},
links: {}
}Confirm that the API Key is valid. POST the api key in the data packet: {"api_key": "somekey"} If no API Key is provided, we will try to use the saved one
https://api.mantiumai.com/v1/provider/verify_key/{ai_provider}
Requirements:
- ai_provider* (string) provider name
- api_key (string) proider api key, This is optional AI Provider API Key. If not present, then we use the saved key.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.ProviderIntegrations('cohere')
.verifyKey({ api_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' })
.then((response) => {
console.log('*********** Provider Integrations Verify Key response *********');
console.log(response);
});
})();*********** Provider Integrations Verify Key response *********
[ 'The cohere api key is good!' ]Save and verify a provider api key for your selected organization - if one exists already, overwrite it. If the "verified" value in the payload is included and set to true, we will assume it is verified.
https://api.mantiumai.com/v1/provider/save_key/{ai_provider}
Requirements:
- ai_provider* (string) provider name
- api_key* (string) AI Provider API Key.
- verified (boolean) If TRUE, we will assume the key is good and not attempt to verify it.
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.ProviderIntegrations('openai')
.saveKey({ api_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', verified: false })
.then((response) => {
console.log('*********** Provider Integrations Verify Key response *********');
console.log(response);
});
})();*********** Provider Integrations Verify Key response *********
{
data: {
id: 'OpenAI',
type: 'api_key',
attributes: {
ai_provider: 'OpenAI',
verified: true,
created: {
timestamp: '2022-05-29 14:27:33.147132+00:00',
user_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
full_name: ' ',
email: 'user@emai.com'
},
updated: null
},
relationships: {}
},
included: [],
meta: {},
links: {}
}Get a summary of the api keys your selected organization currently has configured.
https://api.mantiumai.com/v1/provider/delete_key/{ai_provider}
Requirements:
- ai_provider* (string) provider name
const mantiumAi = require('@mantium/mantiumapi');
(async () => {
await mantiumAi.Auth().accessTokenLogin({
username: 'useremail@somedomain.com',
password: 'p@ssWord!'
})
.then((response) => {
// get bearer_id and set to default
mantiumAi.api_key = response.data.attributes.bearer_id;
return response;
});
/*
* API Key is set on above
* mantiumAi.api_key=`key`
* so we can call these method directly now
*/
await mantiumAi
.ProviderIntegrations('openai')
.removeKey()
.then((response) => {
console.log('*********** Provider Integrations Remove Key response *********');
console.log(response);
});
})();*********** Provider Integrations Remove Key response *********
Deleted 1 key