REST API (1.0.0)

Download OpenAPI specification:Download

auth

permissions

path Parameters

project_id

required

string

Responses

token list

Responses

token create

Request Body schema: application/json

	object
name	string

Responses

Request samples

Payload

Content type

application/json

{"expires": {"measure": "minutes",
"value": 30
},
"name": "test"
}

user

Responses

projects

add group

path Parameters

project_id

required

string

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "test group"
}

remove group

path Parameters

project_id required	string
group_id required	string

Request Body schema: text/plain

string <binary>

Responses

list groups

Responses

edit groups

path Parameters

project_id

required

string

Request Body schema: application/json

groups

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"groups": ["group",
"group2",
"Yellow",
"Blue"
]
}

monitoring filter

Responses

list

path Parameters

public_project_id

required

string

query Parameters

check_public_role	string
limit	string
offset	string
search	string

Responses

promptlib

recently approved

Responses

approve

Responses

approve

Responses

author

Responses

delete_collections

path Parameters

project_id

required

string

Responses

patch_collection

path Parameters

project_id

required

string

Request Body schema: application/json

operation	string
	object

Responses

Request samples

Payload

Content type

application/json

{"operation": "remove",
"prompt": {"id": 3,
"owner_id": 1
}
}

Response samples

200
404

Content type

application/json

{"author": {"email": "admin@centry.user",
"id": 1,
"last_login": "2023-11-29T09:57:22.967941",
"name": "admin@centry.user"
},
"description": "Lorem ipsum dolor sit amet consectetur adipisicing elit. Maxime mollitia, molestiae quas vel sint commodi repudiandae consequuntur voluptatum laborum numquam blanditiis harum quisquam eius sed odit fugiat iusto fuga praesentium",
"id": 1,
"name": "test",
"owner_id": 1,
"prompts": [{"tags": null,
"author_ids": [ ],
"authors": [ ],
"created_at": "2023-11-29T06:08:06.824725",
"description": "This is a test prompt created from postman request",
"id": 1,
"name": "project_1_1",
"owner_id": 1
},
{"tags": null,
"author_ids": [ ],
"authors": [ ],
"created_at": "2023-11-29T06:08:12.765293",
"description": "This is a test prompt created from postman request",
"id": 2,
"name": "project_1_2",
"owner_id": 1
}
]
}

update_collection

path Parameters

project_id

required

string

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"prompts": [{"id": 1,
"owner_id": 1
},
{"id": 2,
"owner_id": 1
}
]
}

detail_collection

path Parameters

project_id required	string
collection_id required	string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "Test description",
"name": "test_collection"
}

list_collections

Get Prompt Library Collection

This endpoint retrieves a prompt library collection for a specific project.

Request

Endpoint

GET /prompt_lib/collections/prompt_lib/

Response

Status: 200

{
    "rows": [
        {
            "id": 0,
            "name": "",
            "description": "",
            "owner_id": 0,
            "status": "",
            "author": {
                "id": 0,
                "email": "",
                "name": "",
                "last_login": "",
                "avatar": ""
            },
            "tags": [
                {
                    "name": "",
                    "data": {
                        "color": ""
                    }
                }
            ],
            "created_at": "",
            "includes_prompt": null,
            "prompt_count": 0
        }
    ],
    "total": 0
}

Add Documentation

Documentation for this endpoint is not available.

path Parameters

project_id

required

string

query Parameters

author_id	string
prompt_id	string
prompt_owner_id	string
my_liked	string filter collections by my liked only
trend_start_period	string
statuses	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"tags": [{"data": {"color": "red"
},
"name": "bard"
}
],
"author": {"avatar": "https://static.cdn.epam.com/avatar/0e626c89e88f0ff9b3b5e864ea0a56a1.jpg",
"email": "artem_dubrovskii@epam.com",
"id": 1,
"last_login": "2024-01-15T19:29:07.711584",
"name": "Artem Dubrovskii"
},
"created_at": "2024-01-15T14:54:45.695551",
"description": "Contains various useful stuff",
"id": 1,
"includes_prompt": null,
"is_liked": true,
"likes": 3,
"name": "First collection",
"owner_id": 1,
"prompt_count": 2,
"status": "published"
}
],
"total": 1
}

export all prompts

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

import

path Parameters

project_id

required

string

query Parameters

from_dial

string

Request Body schema: application/json

collections	Array of any
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"collections": [ ],
"prompts": [{"description": "imported",
"name": "imported prompt1",
"owner_id": 1,
"versions": [{"tags": [{"data": {"color": "blue"
},
"name": "test_tag_2"
},
{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is latest ",
"embedding_settings": { },
"messages": [{"content": "test_content human",
"custom_content": null,
"name": null,
"role": "user"
},
{"content": "test_content bot",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": null,
"name": "latest",
"prompt_id": 1,
"type": "freeform",
"variables": [{"name": "var",
"value": "val1"
}
]
},
{"tags": [{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is test",
"embedding_settings": null,
"messages": [ ],
"model_settings": null,
"name": "test",
"prompt_id": 1,
"type": "freeform",
"variables": [ ]
},
{"tags": [{"data": {"color": "blue"
},
"name": "test_tag_2"
},
{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is stable",
"embedding_settings": null,
"messages": [ ],
"model_settings": null,
"name": "stable",
"prompt_id": 1,
"type": "freeform",
"variables": [ ]
}
]
}
]
}

Response samples

201

Content type

application/json

{"created": [{"created_at": "2023-11-23T15:34:27.490920",
"description": "imported",
"id": 36,
"name": "imported prompt1",
"owner_id": 1,
"version_details": null,
"versions": [{"created_at": "2023-11-23T15:34:27.490920",
"id": 47,
"name": "latest",
"status": "draft"
},
{"created_at": "2023-11-23T15:34:27.490920",
"id": 48,
"name": "test",
"status": "draft"
},
{"created_at": "2023-11-23T15:34:27.490920",
"id": 49,
"name": "stable",
"status": "draft"
}
]
}
],
"errors": [ ]
}

export one prompt

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

export collection

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

Response samples

200

Content type

application/json

{"author_id": 1,
"description": "Contains various useful stuff",
"name": "First collection",
"owner_id": 3,
"prompts": [{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones. Count only alphanumerical cheracters",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "Reformat and beautify the below code:",
"description": "The purpose of this prompt is to reformat and beautify the provided code.",
"folderId": null,
"id": "7",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "EB - Code_Beautifier"
}
],
"shared_id": null,
"shared_owner_id": null
}

import wizard

path Parameters

project_id

required

string

query Parameters

from_dial

string

Request Body schema: application/json

Array

collection_id	any or null
description	string
embedding_model	string
	object
entity	string
isSelected	boolean
name	string
owner_id	number
shared_id	any or null
shared_owner_id	any or null
storage	string
storage_settings	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[{"collection_id": null,
"description": "Some description of prompt",
"entity": "prompts",
"isSelected": true,
"name": "medieval",
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "code"
}
],
"author_id": 2,
"commit_message": null,
"context": "reply as a medieval bartender",
"isSelected": true,
"messages": [{"content": "hello",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": {"max_tokens": 512,
"model": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo",
"gpt-4",
"gpt-4-32k"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "latest",
"type": "chat",
"variables": [ ]
},
{"tags": [{"data": {"color": "red"
},
"name": "code"
}
],
"author_id": 2,
"commit_message": null,
"context": "reply as a medieval bartender",
"isSelected": true,
"messages": [{"content": "hello",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": {"max_tokens": 512,
"model": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "another",
"type": "chat",
"variables": [ ]
}
]
},
{"description": "Used for import/export testing",
"embedding_model": "dfd70670-cd52-43d8-9365-0af0536da49c",
"embedding_model_settings": {"model_name": "sentence-transformers/all-MiniLM-L6-v2"
},
"entity": "datasources",
"isSelected": true,
"name": "My Test Datasource of admin 1",
"storage": "Chroma",
"storage_settings": { },
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "testing"
},
{"data": {"color": "red"
},
"name": "ai"
},
{"data": {"color": "red"
},
"name": "development"
}
],
"context": "You are master kung fu of the pandas. Provide me some kick",
"conversation_starters": [ ],
"created_at": "2024-06-27T11:48:43.071785",
"datasets": [{"datasource_version_id": 2,
"log_payload": true,
"source": {"name": "alitaui_react",
"options": {"advanced": {"default_loader": "TextLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "main",
"ssh_key": "",
"type": "https",
"url": "https://github.com/ProjectAlita/AlitaUI.git"
},
"type": "git"
},
"summarization": {"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}
],
"datasource_settings": {"chat": {"chat_settings_ai": null,
"chat_settings_embedding": {"cut_off_score": 0.5,
"fetch_k": 30,
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": null,
"search": null
},
"isSelected": true,
"name": "v1",
"welcome_message": ""
}
]
},
{"description": "Test",
"embedding_model": "40d7c7b2-38f5-4523-9278-ae099930fd81",
"embedding_model_settings": {"model_name": "sentence-transformers/all-MiniLM-L6-v2"
},
"entity": "datasources",
"isSelected": true,
"name": "Test",
"storage": "Pgvector",
"storage_settings": { },
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "testing"
},
{"data": {"color": "red"
},
"name": "ai"
},
{"data": {"color": "red"
},
"name": "development"
}
],
"context": "You are master kung fu of the pandas. Provide me some kick",
"conversation_starters": [ ],
"created_at": "2024-06-27T11:48:43.071785",
"datasets": [{"datasource_version_id": 2,
"log_payload": true,
"source": {"name": "alitaui_react",
"options": {"advanced": {"default_loader": "TextLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "main",
"password": "",
"type": "https",
"url": "https://github.com/ProjectAlita/AlitaUI.git",
"username": ""
},
"type": "git"
},
"summarization": {"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}
],
"datasource_settings": {"chat": {"chat_settings_ai": null,
"chat_settings_embedding": {"cut_off_score": 0.5,
"fetch_k": 30,
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": null,
"search": null
},
"name": "v2",
"welcome_message": ""
}
]
},
{"description": "Description about",
"entity": "agents",
"isSelected": true,
"name": "Agent for Testing ",
"owner_id": 2,
"shared_id": null,
"shared_owner_id": null,
"versions": [{"tags": [{"data": {"color": "red"
},
"id": 4,
"name": "new tag"
}
],
"agent_type": "react",
"application_id": 4,
"author": {"avatar": "https://static.cdn.epam.com/avatar/36e4bc3c44672c3ee5fe4ba4310c2463.jpg",
"email": "irina_selivanova@epam.com",
"id": 89,
"name": "Irina Selivanova"
},
"conversation_starters": [ ],
"created_at": "2024-07-29T06:29:27.313286",
"id": 5,
"instructions": "",
"isSelected": true,
"llm_settings": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"max_tokens": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_k": 20,
"top_p": 0.8
},
"name": "latest",
"shared_id": null,
"shared_owner_id": null,
"status": "draft",
"tools": [{"description": "Description about Agent",
"id": 38,
"name": "Agent testing name",
"settings": {"application_id": 4,
"application_version_id": 5,
"variables": [ ]
},
"type": "application"
},
{"description": "Browser description for testing",
"id": 39,
"name": "Testing browser tool",
"settings": {"google_api_key": "",
"google_cse_id": "MY_TEST_CSE_ID",
"selected_tools": ["wiki",
"single_url_crawler",
"multi_url_crawler",
"get_html_content",
"google"
]
},
"type": "browser"
},
{"description": "About confluence (testing)",
"id": 40,
"name": "Confluence with API as Secret",
"settings": {"api_key": "",
"base_url": "https://epam.com/confluence",
"cloud": false,
"limit": 5,
"max_pages": 10,
"max_retry_seconds": 60,
"min_retry_seconds": 10,
"number_of_retries": 2,
"selected_tools": ["get_pages_with_label",
"search_pages"
],
"space": "MyTestingSpace",
"username": "abc12345_test_username"
},
"type": "confluence"
},
{"description": "kv",
"id": 41,
"name": "kv",
"settings": {"datasource_id": 1,
"selected_tools": ["chat",
"search"
]
},
"type": "datasource"
},
{"description": "About GitHub tool for testing",
"id": 42,
"name": "GitHub testing Tool with PK secret",
"settings": {"active_branch": "main",
"app_id": "MyAppID",
"app_private_key": "",
"base_branch": "main",
"repository": "myrepo",
"selected_tools": ["get_issues",
"get_issue",
"comment_on_issue",
"list_open_pull_requests",
"get_pull_request",
"list_pull_request_files",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"list_files_in_main_branch",
"list_branches_in_repo",
"set_active_branch",
"create_branch",
"get_files_from_directory"
]
},
"type": "github"
},
{"description": "About gitlab",
"id": 43,
"name": "GitLab testing tool with password token",
"settings": {"branch": "main",
"private_token": "",
"repository": "myrepo",
"selected_tools": ["create_branch",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"set_active_branch",
"list_branches_in_repo",
"get_pr_changes",
"create_pr_change_comment"
],
"url": "https://domain.com"
},
"type": "gitlab"
},
{"description": "About Jira for testing",
"id": 44,
"name": "Jira with Token Secret",
"settings": {"additional_fields": "",
"base_url": "https://domain.com/custom-url",
"cloud": false,
"limit": 5,
"selected_tools": ["search_using_jql",
"create_issue",
"update_issue",
"add_comments",
"list_projects",
"set_issue_status"
],
"token": "",
"verify_ssl": true
},
"type": "jira"
},
{"description": null,
"id": 45,
"name": "OpenAPI tool (testing)",
"settings": {"authentication": {"settings": {"auth_url": "https://domain.com/",
"client_id": "ClientIDValue_test",
"client_secret": "ClientSecretValue_test",
"method": "Basic",
"scope": "myScopeABC",
"token_url": "tokenURL-agent_for_testing"
},
"type": "oauth"
},
"schema_settings": "Open API schema to communication with an OPEN API",
"selected_tools": [ ]
},
"type": "openapi"
},
{"description": "Prompt with Variables",
"id": 46,
"name": "Prompt with Variables",
"settings": {"prompt_id": 9,
"prompt_version_id": 11,
"variables": [{"name": "var1",
"value": "value1_testing_new"
},
{"name": "var2",
"value": "value2_testing_new2"
}
]
},
"type": "prompt"
}
],
"variables": [ ],
"welcome_message": ""
},
{"tags": [{"data": {"color": "red"
},
"id": 4,
"name": "new tag"
}
],
"agent_type": "react",
"application_id": 4,
"author": {"avatar": "https://static.cdn.epam.com/avatar/36e4bc3c44672c3ee5fe4ba4310c2463.jpg",
"email": "irina_selivanova@epam.com",
"id": 89,
"name": "Irina Selivanova"
},
"conversation_starters": [ ],
"created_at": "2024-08-27T06:08:24.367554",
"id": 6,
"instructions": "",
"isSelected": true,
"llm_settings": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"max_tokens": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_k": 20,
"top_p": 0.8
},
"name": "initial",
"shared_id": null,
"shared_owner_id": null,
"status": "draft",
"tools": [{"description": "Prompt with Variables",
"id": 47,
"name": "Prompt with Variables",
"settings": {"prompt_id": 9,
"prompt_version_id": 11,
"variables": [{"name": "var1",
"value": "value1_testing_new"
},
{"name": "var2",
"value": "value2_testing_new2"
}
]
},
"type": "prompt"
},
{"description": "Description about Agent",
"id": 48,
"name": "Agent testing name",
"settings": {"application_id": 4,
"application_version_id": 5,
"variables": [ ]
},
"type": "application"
},
{"description": null,
"id": 49,
"name": "OpenAPI tool (testing)",
"settings": {"authentication": {"settings": {"auth_url": "https://domain.com/",
"client_id": "ClientIDValue_test",
"client_secret": "ClientSecretValue_test",
"method": "Basic",
"scope": "myScopeABC",
"token_url": "tokenURL-agent_for_testing"
},
"type": "oauth"
},
"schema_settings": "Open API schema to communication with an OPEN API",
"selected_tools": [ ]
},
"type": "openapi"
},
{"description": "About Jira for testing",
"id": 50,
"name": "Jira with Token Secret",
"settings": {"additional_fields": "",
"api_key": null,
"base_url": "https://domain.com/custom-url",
"cloud": false,
"limit": 5,
"selected_tools": ["search_using_jql",
"create_issue",
"update_issue",
"add_comments",
"list_projects",
"set_issue_status"
],
"token": "",
"username": null,
"verify_ssl": true
},
"type": "jira"
},
{"description": "About gitlab",
"id": 51,
"name": "GitLab testing tool with password token",
"settings": {"branch": "main",
"private_token": "",
"repository": "myrepo",
"selected_tools": ["create_branch",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"set_active_branch",
"list_branches_in_repo",
"get_pr_changes",
"create_pr_change_comment"
],
"url": "https://domain.com"
},
"type": "gitlab"
},
{"description": "About GitHub tool for testing",
"id": 52,
"name": "GitHub testing Tool with PK secret",
"settings": {"access_token": null,
"active_branch": "main",
"app_id": "MyAppID",
"app_private_key": "",
"base_branch": "main",
"password": null,
"repository": "myrepo",
"selected_tools": ["get_issues",
"get_issue",
"comment_on_issue",
"list_open_pull_requests",
"get_pull_request",
"list_pull_request_files",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"list_files_in_main_branch",
"list_branches_in_repo",
"set_active_branch",
"create_branch",
"get_files_from_directory"
],
"username": null
},
"type": "github"
},
{"description": "kv",
"id": 53,
"name": "kv",
"settings": {"datasource_id": 1,
"selected_tools": ["chat",
"search"
]
},
"type": "datasource"
},
{"description": "About confluence (testing)",
"id": 54,
"name": "Confluence with Token as password",
"settings": {"api_key": null,
"base_url": "https://epam.com/confluence",
"cloud": false,
"limit": 5,
"max_pages": 10,
"max_retry_seconds": 60,
"min_retry_seconds": 10,
"number_of_retries": 2,
"selected_tools": ["get_pages_with_label",
"search_pages"
],
"space": "MyTestingSpace",
"token": "",
"username": null
},
"type": "confluence"
},
{"description": "Browser description for testing",
"id": 55,
"name": "Testing browser tool",
"settings": {"google_api_key": "",
"google_cse_id": "MY_TEST_CSE_ID",
"selected_tools": ["wiki",
"single_url_crawler",
"multi_url_crawler",
"get_html_content",
"google"
]
},
"type": "browser"
}
],
"variables": [ ],
"welcome_message": ""
}
]
}
]

magic assistant

Allows to create prompt from user input.

Response example:

{
    "name": "suggested prompt name",
    "description": "suggested prompt description",
    "context": "main context of prompt",
    "welcome_message": "some text",
    "conversation_starters": ["example 1", "example 2"],
    "messages": null
}

path Parameters

project_id

required

string

Request Body schema: application/json

user_input

string

Responses

Request samples

Payload

Content type

application/json

{"user_input": "Create cocktails prompt"
}

predict - no prompt_id

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
format_response	boolean
	Array of objects
	object
type	string
user_input	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"chat_history": [{"content": "Hi",
"name": "Hawk",
"role": "user"
},
{"content": "Hi! How can I assist you today?",
"role": "assistant"
}
],
"context": "You help me generate jokes on different topics. ",
"format_response": true,
"messages": [{"content": "software engineers",
"role": "user"
},
{"content": "Why do software engineers prefer dark mode? \n\nBecause light attracts bugs.",
"role": "assistant"
}
],
"model_settings": {"max_tokens": 1000,
"model": {"integration_name": "my_integration",
"integration_uid": "",
"model_name": "gpt-4"
},
"stream": true,
"temperature": 0.9,
"top_k": 2,
"top_p": 0.6
},
"type": "chat",
"user_input": "How about cats?",
"variables": [{"name": "additional_queries",
"value": "Generate 3 jokes at once"
}
]
}

Response samples

200
400

Content type

application/json

{"messages": [{"content": "Hello! How can I assist you today?",
"type": "text"
}
]
}

predict - with prompt_id

path Parameters

project_id

required

string

Request Body schema: application/json

format_response	boolean
	object
user_input	string

Responses

Request samples

Payload

Content type

application/json

{"format_response": true,
"model_settings": {"max_tokens": 1000,
"model": {"integration_uid": "",
"model_name": "gpt-4"
},
"stream": false,
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"user_input": "Who are you?"
}

Response samples

200

Content type

application/json

{"messages": [{"content": "Because it's always full of bugs!",
"type": "text"
}
]
}

details

path Parameters

project_id

required

string

Responses

details - with version

path Parameters

project_id

required

string

Responses

delete

path Parameters

project_id

required

string

Responses

list [old]

path Parameters

project_id

required

string

Responses

create [old]

path Parameters

project_id

required

string

Request Body schema: application/json

name	string
prompt	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"name": "test_old",
"prompt": "test old",
"type": "chat"
}

list

path Parameters

project_id

required

string

query Parameters

offset	string
tags	string
limit	string
author_id	string
sort_by	string
sort_order	string
statuses	string
query	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"tags": [{"data": {"color": "green"
},
"id": 1,
"name": "test_tag_1"
}
],
"authors": [{"email": "admin@centry.user",
"id": 1,
"last_login": "2023-12-07T15:40:39.779011",
"name": "admin@centry.user"
}
],
"created_at": "2023-12-06T08:19:43.584036",
"description": "",
"id": 1,
"name": "tst",
"owner_id": 2,
"status": "on_moderation"
}
],
"total": 1
}

create

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string
type	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "",
"name": "tst",
"type": "chat",
"versions": [{"tags": [ ],
"context": "",
"messages": [ ],
"model_settings": {"max_tokens": 100,
"model": {"integration_uid": "a925b875-50b8-4164-942a-308d0105ed89",
"name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "latest",
"variables": [ ]
}
]
}

Response samples

201
400

Content type

application/json

{"created_at": "2023-11-22T15:22:09.975692",
"description": "This is a test prompt created from postman request",
"id": 1,
"name": "test_prompt",
"owner_id": 9,
"version_details": {"tags": [{"data": {"color": "red"
},
"id": 1,
"name": "test_tag_1"
},
{"data": {"color": "blue"
},
"id": 2,
"name": "test_tag_2"
}
],
"author": {"email": "system_p_7@centry.user",
"id": 7,
"last_login": "2023-11-21T14:36:55.413891",
"name": ":System:Project:7:"
},
"author_id": 7,
"commit_message": null,
"context": null,
"created_at": "2023-11-22T15:22:09.975692",
"embedding_settings": null,
"id": 1,
"messages": [ ],
"model_settings": {"max_tokens": 1000,
"model": {"integration_name": "ai_dial",
"integration_uid": "123456",
"name": "gpt-4"
},
"stream": false,
"suggested_models": ["gpt-4"
],
"temperature": 0.8,
"top_k": 20,
"top_p": 0.7
},
"name": "latest",
"prompt_id": 1,
"status": "draft",
"type": "chat",
"variables": [{"created_at": "2023-11-22T15:22:09.975692",
"id": 1,
"name": "test_var1",
"prompt_version_id": 1,
"updated_at": null,
"value": "test_var1_value"
}
]
},
"versions": [{"created_at": "2023-11-22T15:22:09.975692",
"id": 1,
"name": "latest",
"status": "draft"
}
]
}

detail_collection public

Responses

details public

Responses

list public

query Parameters

limit	string
offset	string
tags	string
sort_by	string
sort_order	string
query	string
my_liked	string filter prompts by my liked only
trend_start_period	string

Request Body schema: text/plain

string <binary>

Responses

publish

path Parameters

project_id

required

string

Responses

publish_collection

path Parameters

project_id

required

string

Responses

reject

Responses

reject

Responses

search_options

path Parameters

project_id

required

string

query Parameters

query	string
limit	string
offset	string
sort	string
order	string
prompt_limit	string
prompt_offset	string
tag_limit	string
tag_offset	string
col_limit	string
col_offset	string
tags[]	string Filtering by tags
entities[]	string adding tags to result
statuses[]	string
prompt_sort	string
prompt_order	string
datasource_sort	string
datasource_order	string
application_sort	string

Responses

search requests

path Parameters

project_id

required

string

query Parameters

limit	string
offset	string

Responses

tags - by prompt

path Parameters

project_id

required

string

Responses

tags (categories)

path Parameters

public_project_id

required

string

query Parameters

limit	string
offset	string
sort_by	string
sort_order	string
author_id	string
query	string get tags fitting search prompts list
statuses	string
collection_phrase	string get tags fitting search collection list
my_liked	string return only tags for related entities that you liked
my_liked_collections	string return only tags for collections that you liked
search	string filters tags by name
entity_coverage	string Currently, entity coverage might be 'all', 'datasource', and 'prompt'

Responses

trending authors

path Parameters

public_project_id

required

string

Responses

unpublish

path Parameters

project_id

required

string

Responses

unpublish_collection

path Parameters

project_id

required

string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
	Array of objects
name	string
type	string
variables	Array of any

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "green"
},
"name": "test_tag_1"
},
{"name": "rejected"
}
],
"context": "New version context",
"messages": [{"content": "new version test_content human",
"role": "user"
},
{"content": "new version test_content bot",
"role": "assistant"
}
],
"name": "new_version4",
"type": "chat",
"variables": [ ]
}

delete

path Parameters

project_id

required

string

Responses

details

path Parameters

project_id

required

string

Responses

edit latest

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
messages	Array of any
	object
name	string
type	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "#efe482"
},
"name": "tag2"
},
{"data": {"color": "#5933c6"
},
"name": "tag1"
}
],
"context": "This is the context which contains two variables var1 and var2, . and ",
"messages": [ ],
"model_settings": {"max_tokens": 900,
"model": {"integration_uid": "a925b875-50b8-4164-942a-308d0105ed89",
"name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.79,
"top_k": 27,
"top_p": 0.8
},
"name": "latest",
"type": "chat",
"variables": [{"name": "var44",
"value": "44"
},
{"name": "var1",
"value": "value11"
}
]
}

prompts

details

path Parameters

project_id

required

string

Responses

details - with version

path Parameters

project_id

required

string

Responses

delete

path Parameters

project_id

required

string

Responses

list

path Parameters

project_id

required

string

query Parameters

offset	string
tags	string
limit	string
author_id	string
sort_by	string
sort_order	string
statuses	string
query	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"tags": [{"data": {"color": "green"
},
"id": 1,
"name": "test_tag_1"
}
],
"authors": [{"email": "admin@centry.user",
"id": 1,
"last_login": "2023-12-07T15:40:39.779011",
"name": "admin@centry.user"
}
],
"created_at": "2023-12-06T08:19:43.584036",
"description": "",
"id": 1,
"name": "tst",
"owner_id": 2,
"status": "on_moderation"
}
],
"total": 1
}

create

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string
type	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "",
"name": "tst",
"type": "chat",
"versions": [{"tags": [ ],
"context": "",
"messages": [ ],
"model_settings": {"max_tokens": 100,
"model": {"integration_uid": "a925b875-50b8-4164-942a-308d0105ed89",
"name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "latest",
"variables": [ ]
}
]
}

Response samples

201
400

Content type

application/json

{"created_at": "2023-11-22T15:22:09.975692",
"description": "This is a test prompt created from postman request",
"id": 1,
"name": "test_prompt",
"owner_id": 9,
"version_details": {"tags": [{"data": {"color": "red"
},
"id": 1,
"name": "test_tag_1"
},
{"data": {"color": "blue"
},
"id": 2,
"name": "test_tag_2"
}
],
"author": {"email": "system_p_7@centry.user",
"id": 7,
"last_login": "2023-11-21T14:36:55.413891",
"name": ":System:Project:7:"
},
"author_id": 7,
"commit_message": null,
"context": null,
"created_at": "2023-11-22T15:22:09.975692",
"embedding_settings": null,
"id": 1,
"messages": [ ],
"model_settings": {"max_tokens": 1000,
"model": {"integration_name": "ai_dial",
"integration_uid": "123456",
"name": "gpt-4"
},
"stream": false,
"suggested_models": ["gpt-4"
],
"temperature": 0.8,
"top_k": 20,
"top_p": 0.7
},
"name": "latest",
"prompt_id": 1,
"status": "draft",
"type": "chat",
"variables": [{"created_at": "2023-11-22T15:22:09.975692",
"id": 1,
"name": "test_var1",
"prompt_version_id": 1,
"updated_at": null,
"value": "test_var1_value"
}
]
},
"versions": [{"created_at": "2023-11-22T15:22:09.975692",
"id": 1,
"name": "latest",
"status": "draft"
}
]
}

details public

Responses

list public

query Parameters

limit	string
offset	string
tags	string
sort_by	string
sort_order	string
query	string
my_liked	string filter prompts by my liked only
trend_start_period	string

Request Body schema: text/plain

string <binary>

Responses

publish

path Parameters

project_id

required

string

Responses

unpublish

path Parameters

project_id

required

string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
	Array of objects
name	string
type	string
variables	Array of any

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "green"
},
"name": "test_tag_1"
},
{"name": "rejected"
}
],
"context": "New version context",
"messages": [{"content": "new version test_content human",
"role": "user"
},
{"content": "new version test_content bot",
"role": "assistant"
}
],
"name": "new_version4",
"type": "chat",
"variables": [ ]
}

delete

path Parameters

project_id

required

string

Responses

details

path Parameters

project_id

required

string

Responses

edit latest

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
messages	Array of any
	object
name	string
type	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "#efe482"
},
"name": "tag2"
},
{"data": {"color": "#5933c6"
},
"name": "tag1"
}
],
"context": "This is the context which contains two variables var1 and var2, . and ",
"messages": [ ],
"model_settings": {"max_tokens": 900,
"model": {"integration_uid": "a925b875-50b8-4164-942a-308d0105ed89",
"name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.79,
"top_k": 27,
"top_p": 0.8
},
"name": "latest",
"type": "chat",
"variables": [{"name": "var44",
"value": "44"
},
{"name": "var1",
"value": "value11"
}
]
}

versions

delete

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
context	string
	Array of objects
name	string
type	string
variables	Array of any

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "green"
},
"name": "test_tag_1"
},
{"name": "rejected"
}
],
"context": "New version context",
"messages": [{"content": "new version test_content human",
"role": "user"
},
{"content": "new version test_content bot",
"role": "assistant"
}
],
"name": "new_version4",
"type": "chat",
"variables": [ ]
}

delete

path Parameters

project_id

required

string

Responses

details

path Parameters

project_id

required

string

Responses

public

details public

Responses

list public

query Parameters

limit	string
offset	string
tags	string
sort_by	string
sort_order	string
query	string
my_liked	string filter prompts by my liked only
trend_start_period	string

Request Body schema: text/plain

string <binary>

Responses

export/import

export all prompts

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

import

path Parameters

project_id

required

string

query Parameters

from_dial

string

Request Body schema: application/json

collections	Array of any
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"collections": [ ],
"prompts": [{"description": "imported",
"name": "imported prompt1",
"owner_id": 1,
"versions": [{"tags": [{"data": {"color": "blue"
},
"name": "test_tag_2"
},
{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is latest ",
"embedding_settings": { },
"messages": [{"content": "test_content human",
"custom_content": null,
"name": null,
"role": "user"
},
{"content": "test_content bot",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": null,
"name": "latest",
"prompt_id": 1,
"type": "freeform",
"variables": [{"name": "var",
"value": "val1"
}
]
},
{"tags": [{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is test",
"embedding_settings": null,
"messages": [ ],
"model_settings": null,
"name": "test",
"prompt_id": 1,
"type": "freeform",
"variables": [ ]
},
{"tags": [{"data": {"color": "blue"
},
"name": "test_tag_2"
},
{"data": {"color": "red"
},
"name": "test_tag_1"
}
],
"author_id": 1,
"commit_message": null,
"context": "this is stable",
"embedding_settings": null,
"messages": [ ],
"model_settings": null,
"name": "stable",
"prompt_id": 1,
"type": "freeform",
"variables": [ ]
}
]
}
]
}

Response samples

201

Content type

application/json

{"created": [{"created_at": "2023-11-23T15:34:27.490920",
"description": "imported",
"id": 36,
"name": "imported prompt1",
"owner_id": 1,
"version_details": null,
"versions": [{"created_at": "2023-11-23T15:34:27.490920",
"id": 47,
"name": "latest",
"status": "draft"
},
{"created_at": "2023-11-23T15:34:27.490920",
"id": 48,
"name": "test",
"status": "draft"
},
{"created_at": "2023-11-23T15:34:27.490920",
"id": 49,
"name": "stable",
"status": "draft"
}
]
}
],
"errors": [ ]
}

export one prompt

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

export collection

path Parameters

project_id

required

string

query Parameters

as_file	string
to_dial	string

Responses

Response samples

200

Content type

application/json

{"author_id": 1,
"description": "Contains various useful stuff",
"name": "First collection",
"owner_id": 3,
"prompts": [{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones. Count only alphanumerical cheracters",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "count the number of each character in my input and return a table with frequencies sorted from the most used ones to the least used ones",
"description": "just testing",
"folderId": null,
"id": "1",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "counter"
},
{"content": "Reformat and beautify the below code:",
"description": "The purpose of this prompt is to reformat and beautify the provided code.",
"folderId": null,
"id": "7",
"model": {"iconUrl": null,
"id": "gpt-4",
"isDefault": null,
"maxLength": null,
"name": null,
"requestLimit": null,
"type": null
},
"name": "EB - Code_Beautifier"
}
],
"shared_id": null,
"shared_owner_id": null
}

import wizard

path Parameters

project_id

required

string

query Parameters

from_dial

string

Request Body schema: application/json

Array

collection_id	any or null
description	string
embedding_model	string
	object
entity	string
isSelected	boolean
name	string
owner_id	number
shared_id	any or null
shared_owner_id	any or null
storage	string
storage_settings	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[{"collection_id": null,
"description": "Some description of prompt",
"entity": "prompts",
"isSelected": true,
"name": "medieval",
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "code"
}
],
"author_id": 2,
"commit_message": null,
"context": "reply as a medieval bartender",
"isSelected": true,
"messages": [{"content": "hello",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": {"max_tokens": 512,
"model": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo",
"gpt-4",
"gpt-4-32k"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "latest",
"type": "chat",
"variables": [ ]
},
{"tags": [{"data": {"color": "red"
},
"name": "code"
}
],
"author_id": 2,
"commit_message": null,
"context": "reply as a medieval bartender",
"isSelected": true,
"messages": [{"content": "hello",
"custom_content": null,
"name": null,
"role": "assistant"
}
],
"model_settings": {"max_tokens": 512,
"model": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "gpt-35-turbo"
},
"stream": false,
"suggested_models": ["gpt-35-turbo"
],
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
},
"name": "another",
"type": "chat",
"variables": [ ]
}
]
},
{"description": "Used for import/export testing",
"embedding_model": "dfd70670-cd52-43d8-9365-0af0536da49c",
"embedding_model_settings": {"model_name": "sentence-transformers/all-MiniLM-L6-v2"
},
"entity": "datasources",
"isSelected": true,
"name": "My Test Datasource of admin 1",
"storage": "Chroma",
"storage_settings": { },
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "testing"
},
{"data": {"color": "red"
},
"name": "ai"
},
{"data": {"color": "red"
},
"name": "development"
}
],
"context": "You are master kung fu of the pandas. Provide me some kick",
"conversation_starters": [ ],
"created_at": "2024-06-27T11:48:43.071785",
"datasets": [{"datasource_version_id": 2,
"log_payload": true,
"source": {"name": "alitaui_react",
"options": {"advanced": {"default_loader": "TextLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "main",
"ssh_key": "",
"type": "https",
"url": "https://github.com/ProjectAlita/AlitaUI.git"
},
"type": "git"
},
"summarization": {"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}
],
"datasource_settings": {"chat": {"chat_settings_ai": null,
"chat_settings_embedding": {"cut_off_score": 0.5,
"fetch_k": 30,
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": null,
"search": null
},
"isSelected": true,
"name": "v1",
"welcome_message": ""
}
]
},
{"description": "Test",
"embedding_model": "40d7c7b2-38f5-4523-9278-ae099930fd81",
"embedding_model_settings": {"model_name": "sentence-transformers/all-MiniLM-L6-v2"
},
"entity": "datasources",
"isSelected": true,
"name": "Test",
"storage": "Pgvector",
"storage_settings": { },
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "testing"
},
{"data": {"color": "red"
},
"name": "ai"
},
{"data": {"color": "red"
},
"name": "development"
}
],
"context": "You are master kung fu of the pandas. Provide me some kick",
"conversation_starters": [ ],
"created_at": "2024-06-27T11:48:43.071785",
"datasets": [{"datasource_version_id": 2,
"log_payload": true,
"source": {"name": "alitaui_react",
"options": {"advanced": {"default_loader": "TextLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "main",
"password": "",
"type": "https",
"url": "https://github.com/ProjectAlita/AlitaUI.git",
"username": ""
},
"type": "git"
},
"summarization": {"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}
],
"datasource_settings": {"chat": {"chat_settings_ai": null,
"chat_settings_embedding": {"cut_off_score": 0.5,
"fetch_k": 30,
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": null,
"search": null
},
"name": "v2",
"welcome_message": ""
}
]
},
{"description": "Description about",
"entity": "agents",
"isSelected": true,
"name": "Agent for Testing ",
"owner_id": 2,
"shared_id": null,
"shared_owner_id": null,
"versions": [{"tags": [{"data": {"color": "red"
},
"id": 4,
"name": "new tag"
}
],
"agent_type": "react",
"application_id": 4,
"author": {"avatar": "https://static.cdn.epam.com/avatar/36e4bc3c44672c3ee5fe4ba4310c2463.jpg",
"email": "irina_selivanova@epam.com",
"id": 89,
"name": "Irina Selivanova"
},
"conversation_starters": [ ],
"created_at": "2024-07-29T06:29:27.313286",
"id": 5,
"instructions": "",
"isSelected": true,
"llm_settings": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"max_tokens": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_k": 20,
"top_p": 0.8
},
"name": "latest",
"shared_id": null,
"shared_owner_id": null,
"status": "draft",
"tools": [{"description": "Description about Agent",
"id": 38,
"name": "Agent testing name",
"settings": {"application_id": 4,
"application_version_id": 5,
"variables": [ ]
},
"type": "application"
},
{"description": "Browser description for testing",
"id": 39,
"name": "Testing browser tool",
"settings": {"google_api_key": "",
"google_cse_id": "MY_TEST_CSE_ID",
"selected_tools": ["wiki",
"single_url_crawler",
"multi_url_crawler",
"get_html_content",
"google"
]
},
"type": "browser"
},
{"description": "About confluence (testing)",
"id": 40,
"name": "Confluence with API as Secret",
"settings": {"api_key": "",
"base_url": "https://epam.com/confluence",
"cloud": false,
"limit": 5,
"max_pages": 10,
"max_retry_seconds": 60,
"min_retry_seconds": 10,
"number_of_retries": 2,
"selected_tools": ["get_pages_with_label",
"search_pages"
],
"space": "MyTestingSpace",
"username": "abc12345_test_username"
},
"type": "confluence"
},
{"description": "kv",
"id": 41,
"name": "kv",
"settings": {"datasource_id": 1,
"selected_tools": ["chat",
"search"
]
},
"type": "datasource"
},
{"description": "About GitHub tool for testing",
"id": 42,
"name": "GitHub testing Tool with PK secret",
"settings": {"active_branch": "main",
"app_id": "MyAppID",
"app_private_key": "",
"base_branch": "main",
"repository": "myrepo",
"selected_tools": ["get_issues",
"get_issue",
"comment_on_issue",
"list_open_pull_requests",
"get_pull_request",
"list_pull_request_files",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"list_files_in_main_branch",
"list_branches_in_repo",
"set_active_branch",
"create_branch",
"get_files_from_directory"
]
},
"type": "github"
},
{"description": "About gitlab",
"id": 43,
"name": "GitLab testing tool with password token",
"settings": {"branch": "main",
"private_token": "",
"repository": "myrepo",
"selected_tools": ["create_branch",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"set_active_branch",
"list_branches_in_repo",
"get_pr_changes",
"create_pr_change_comment"
],
"url": "https://domain.com"
},
"type": "gitlab"
},
{"description": "About Jira for testing",
"id": 44,
"name": "Jira with Token Secret",
"settings": {"additional_fields": "",
"base_url": "https://domain.com/custom-url",
"cloud": false,
"limit": 5,
"selected_tools": ["search_using_jql",
"create_issue",
"update_issue",
"add_comments",
"list_projects",
"set_issue_status"
],
"token": "",
"verify_ssl": true
},
"type": "jira"
},
{"description": null,
"id": 45,
"name": "OpenAPI tool (testing)",
"settings": {"authentication": {"settings": {"auth_url": "https://domain.com/",
"client_id": "ClientIDValue_test",
"client_secret": "ClientSecretValue_test",
"method": "Basic",
"scope": "myScopeABC",
"token_url": "tokenURL-agent_for_testing"
},
"type": "oauth"
},
"schema_settings": "Open API schema to communication with an OPEN API",
"selected_tools": [ ]
},
"type": "openapi"
},
{"description": "Prompt with Variables",
"id": 46,
"name": "Prompt with Variables",
"settings": {"prompt_id": 9,
"prompt_version_id": 11,
"variables": [{"name": "var1",
"value": "value1_testing_new"
},
{"name": "var2",
"value": "value2_testing_new2"
}
]
},
"type": "prompt"
}
],
"variables": [ ],
"welcome_message": ""
},
{"tags": [{"data": {"color": "red"
},
"id": 4,
"name": "new tag"
}
],
"agent_type": "react",
"application_id": 4,
"author": {"avatar": "https://static.cdn.epam.com/avatar/36e4bc3c44672c3ee5fe4ba4310c2463.jpg",
"email": "irina_selivanova@epam.com",
"id": 89,
"name": "Irina Selivanova"
},
"conversation_starters": [ ],
"created_at": "2024-08-27T06:08:24.367554",
"id": 6,
"instructions": "",
"isSelected": true,
"llm_settings": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"max_tokens": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_k": 20,
"top_p": 0.8
},
"name": "initial",
"shared_id": null,
"shared_owner_id": null,
"status": "draft",
"tools": [{"description": "Prompt with Variables",
"id": 47,
"name": "Prompt with Variables",
"settings": {"prompt_id": 9,
"prompt_version_id": 11,
"variables": [{"name": "var1",
"value": "value1_testing_new"
},
{"name": "var2",
"value": "value2_testing_new2"
}
]
},
"type": "prompt"
},
{"description": "Description about Agent",
"id": 48,
"name": "Agent testing name",
"settings": {"application_id": 4,
"application_version_id": 5,
"variables": [ ]
},
"type": "application"
},
{"description": null,
"id": 49,
"name": "OpenAPI tool (testing)",
"settings": {"authentication": {"settings": {"auth_url": "https://domain.com/",
"client_id": "ClientIDValue_test",
"client_secret": "ClientSecretValue_test",
"method": "Basic",
"scope": "myScopeABC",
"token_url": "tokenURL-agent_for_testing"
},
"type": "oauth"
},
"schema_settings": "Open API schema to communication with an OPEN API",
"selected_tools": [ ]
},
"type": "openapi"
},
{"description": "About Jira for testing",
"id": 50,
"name": "Jira with Token Secret",
"settings": {"additional_fields": "",
"api_key": null,
"base_url": "https://domain.com/custom-url",
"cloud": false,
"limit": 5,
"selected_tools": ["search_using_jql",
"create_issue",
"update_issue",
"add_comments",
"list_projects",
"set_issue_status"
],
"token": "",
"username": null,
"verify_ssl": true
},
"type": "jira"
},
{"description": "About gitlab",
"id": 51,
"name": "GitLab testing tool with password token",
"settings": {"branch": "main",
"private_token": "",
"repository": "myrepo",
"selected_tools": ["create_branch",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"set_active_branch",
"list_branches_in_repo",
"get_pr_changes",
"create_pr_change_comment"
],
"url": "https://domain.com"
},
"type": "gitlab"
},
{"description": "About GitHub tool for testing",
"id": 52,
"name": "GitHub testing Tool with PK secret",
"settings": {"access_token": null,
"active_branch": "main",
"app_id": "MyAppID",
"app_private_key": "",
"base_branch": "main",
"password": null,
"repository": "myrepo",
"selected_tools": ["get_issues",
"get_issue",
"comment_on_issue",
"list_open_pull_requests",
"get_pull_request",
"list_pull_request_files",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"list_files_in_main_branch",
"list_branches_in_repo",
"set_active_branch",
"create_branch",
"get_files_from_directory"
],
"username": null
},
"type": "github"
},
{"description": "kv",
"id": 53,
"name": "kv",
"settings": {"datasource_id": 1,
"selected_tools": ["chat",
"search"
]
},
"type": "datasource"
},
{"description": "About confluence (testing)",
"id": 54,
"name": "Confluence with Token as password",
"settings": {"api_key": null,
"base_url": "https://epam.com/confluence",
"cloud": false,
"limit": 5,
"max_pages": 10,
"max_retry_seconds": 60,
"min_retry_seconds": 10,
"number_of_retries": 2,
"selected_tools": ["get_pages_with_label",
"search_pages"
],
"space": "MyTestingSpace",
"token": "",
"username": null
},
"type": "confluence"
},
{"description": "Browser description for testing",
"id": 55,
"name": "Testing browser tool",
"settings": {"google_api_key": "",
"google_cse_id": "MY_TEST_CSE_ID",
"selected_tools": ["wiki",
"single_url_crawler",
"multi_url_crawler",
"get_html_content",
"google"
]
},
"type": "browser"
}
],
"variables": [ ],
"welcome_message": ""
}
]
}
]

collections

approve

Responses

delete_collections

path Parameters

project_id

required

string

Responses

patch_collection

path Parameters

project_id

required

string

Request Body schema: application/json

operation	string
	object

Responses

Request samples

Payload

Content type

application/json

{"operation": "remove",
"prompt": {"id": 3,
"owner_id": 1
}
}

Response samples

200
404

Content type

application/json

{"author": {"email": "admin@centry.user",
"id": 1,
"last_login": "2023-11-29T09:57:22.967941",
"name": "admin@centry.user"
},
"description": "Lorem ipsum dolor sit amet consectetur adipisicing elit. Maxime mollitia, molestiae quas vel sint commodi repudiandae consequuntur voluptatum laborum numquam blanditiis harum quisquam eius sed odit fugiat iusto fuga praesentium",
"id": 1,
"name": "test",
"owner_id": 1,
"prompts": [{"tags": null,
"author_ids": [ ],
"authors": [ ],
"created_at": "2023-11-29T06:08:06.824725",
"description": "This is a test prompt created from postman request",
"id": 1,
"name": "project_1_1",
"owner_id": 1
},
{"tags": null,
"author_ids": [ ],
"authors": [ ],
"created_at": "2023-11-29T06:08:12.765293",
"description": "This is a test prompt created from postman request",
"id": 2,
"name": "project_1_2",
"owner_id": 1
}
]
}

update_collection

path Parameters

project_id

required

string

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"prompts": [{"id": 1,
"owner_id": 1
},
{"id": 2,
"owner_id": 1
}
]
}

detail_collection

path Parameters

project_id required	string
collection_id required	string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "Test description",
"name": "test_collection"
}

list_collections

Get Prompt Library Collection

This endpoint retrieves a prompt library collection for a specific project.

Request

Endpoint

GET /prompt_lib/collections/prompt_lib/

Response

Status: 200

{
    "rows": [
        {
            "id": 0,
            "name": "",
            "description": "",
            "owner_id": 0,
            "status": "",
            "author": {
                "id": 0,
                "email": "",
                "name": "",
                "last_login": "",
                "avatar": ""
            },
            "tags": [
                {
                    "name": "",
                    "data": {
                        "color": ""
                    }
                }
            ],
            "created_at": "",
            "includes_prompt": null,
            "prompt_count": 0
        }
    ],
    "total": 0
}

Add Documentation

Documentation for this endpoint is not available.

path Parameters

project_id

required

string

query Parameters

author_id	string
prompt_id	string
prompt_owner_id	string
my_liked	string filter collections by my liked only
trend_start_period	string
statuses	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"tags": [{"data": {"color": "red"
},
"name": "bard"
}
],
"author": {"avatar": "https://static.cdn.epam.com/avatar/0e626c89e88f0ff9b3b5e864ea0a56a1.jpg",
"email": "artem_dubrovskii@epam.com",
"id": 1,
"last_login": "2024-01-15T19:29:07.711584",
"name": "Artem Dubrovskii"
},
"created_at": "2024-01-15T14:54:45.695551",
"description": "Contains various useful stuff",
"id": 1,
"includes_prompt": null,
"is_liked": true,
"likes": 3,
"name": "First collection",
"owner_id": 1,
"prompt_count": 2,
"status": "published"
}
],
"total": 1
}

detail_collection public

Responses

publish_collection

path Parameters

project_id

required

string

Responses

reject

Responses

unpublish_collection

path Parameters

project_id

required

string

Responses

tags - by prompt

path Parameters

project_id

required

string

Responses

tags (categories)

path Parameters

public_project_id

required

string

query Parameters

limit	string
offset	string
sort_by	string
sort_order	string
author_id	string
query	string get tags fitting search prompts list
statuses	string
collection_phrase	string get tags fitting search collection list
my_liked	string return only tags for related entities that you liked
my_liked_collections	string return only tags for collections that you liked
search	string filters tags by name
entity_coverage	string Currently, entity coverage might be 'all', 'datasource', and 'prompt'

Responses

datasources

delete

path Parameters

project_id

required

string

Responses

detail

path Parameters

project_id

required

string

Responses

update

path Parameters

project_id

required

string

Request Body schema: application/json

datasource_version_id	number
name	string
	object
source_type	string
summarization	string
transformers	object

Responses

Request samples

Payload

Content type

application/json

{"datasource_version_id": 1,
"name": "CHANGED",
"source_settings": {"key": "value"
},
"source_type": "gichanget",
"summarization": "row",
"transformers": { }
}

Response samples

200

Content type

application/json

{"created_at": "2024-03-27T12:17:22.009603",
"datasource_version": {"tags": [{"data": {"color": "red"
},
"name": "qa"
}
],
"author_id": 1,
"context": "",
"datasource_id": 1,
"datasource_settings": {"chat": {"chat_settings_ai": {"integration_uid": "6f65f628-840f-470d-af86-e0225e3fd18d",
"maximum_length": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_p": 0.5
},
"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2",
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": {"chat_settings_embedding": {"cut_off_score": 0.3,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2"
}
},
"search": {"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2",
"page_top_k": 5,
"top_k": 20
}
}
},
"name": "latest",
"shared_id": null,
"shared_owner_id": null,
"uuid": "36106f0b-0634-46e9-b6a7-ea60addfc50b"
},
"datasource_version_id": 1,
"id": 1,
"name": "kv",
"source_settings": {"column_delimiter": ",",
"columns": ["key",
"value"
],
"encoding": "auto",
"file": {"bucket": "datasets",
"name": "source_66e18571-1735-48a8-a09f-c3d915766d2c.csv",
"original_name": "test.csv"
},
"json_documents": true,
"raw_content": false
},
"source_type": "table",
"status": "running",
"summarization": {"ai_integration_uid": "",
"ai_model_name": "",
"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"task_id": "6022d598-3dbb-43f5-a783-f7741eadf9d1",
"transformers": {"extract_for_chunks": false,
"extract_for_document": false,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}

list

path Parameters

project_id

required

string

Responses

create Copy tmp

path Parameters

project_id

required

string

Request Body schema: application/json

datasource_version_id	number
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"datasource_version_id": 1,
"source": {"name": "arbiter datasource",
"options": {"advanced": {"default_loader": "PythonLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "tasknode",
"password": "",
"ssh_key": "",
"type": "ssh",
"url": "https://github.com/carrier-io/arbiter.git",
"username": ""
},
"type": "git"
},
"summarization": {"chunkSummarization": false,
"chunkSummarizationPrompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"documentSummarization": false,
"documentSummarizationPrompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": true,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}

update datasource

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string
	object

Responses

Request samples

Payload

Content type

application/json

{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Vitae nibh turpis scelerisque commodo egestas id morbi urna in. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim",
"name": "My datasource UPD",
"version": {"tags": [{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
},
{"data": {"color": "black"
},
"name": "tag4"
}
],
"context": "Write like Vincent van Gogh",
"datasource_settings": {"chat": {"chat_model": {"integration_name": "ai_dial",
"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "anthropic.claude-v2"
},
"embedding_model": {"integration_name": "hugging_face",
"integration_uid": "dfd70670-cd52-43d8-9365-0af0536da49c",
"model_name": "sentence-transformers/all-MiniLM-L6-v2"
},
"max_length": 100,
"temperature": 0.5,
"top_k": 0.2,
"top_p": 0.3
},
"deduplicate": {"cut_off_score": 0.3,
"embedding_model": {"integration_name": "hugging_face",
"integration_uid": "dfd70670-cd52-43d8-9365-0af0536da49c",
"model_name": "sentence-transformers/multi-qa-MiniLM-L6-cos-v1"
}
},
"search": {"cut_off_score": 0.3,
"embedding_model": {"integration_name": "hugging_face",
"integration_uid": "dfd70670-cd52-43d8-9365-0af0536da49c",
"model_name": "sentence-transformers/paraphrase-MiniLM-L6-v2"
},
"top_k": 0.3
}
},
"id": 1
}
}

delete datasource

path Parameters

project_id

required

string

Responses

detail datasource

path Parameters

project_id

required

string

Responses

list datasources

path Parameters

project_id

required

string

query Parameters

offset	string
limit	string
tags	string
sort_order	string
query	string

Responses

create datasource

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
embedding_model	string
	object
name	string
storage	string
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Vitae nibh turpis scelerisque commodo egestas id morbi urna in. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim",
"embedding_model": "45c67415-38b1-4fec-8e77-c12d00648793",
"embedding_model_settings": {"model_name": "sentence-transformers/all-mpnet-base-v2"
},
"name": "My datasource 1",
"storage": "Chroma",
"storage_settings": {"persist_directory": "/data/cache/chroma"
},
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "tag1"
},
{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
}
],
"name": "latest"
}
]
}

deduplicate

path Parameters

project_id

required

string

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"chat_settings_embedding": {"cut_off_score": 0.5,
"integration_uid": "",
"model_name": "sentence-transformers/all-mpnet-base-v2"
}
}

import datasource

path Parameters

project_id

required

string

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"datasources": [{"datasets": [{"source": {"name": "Table test",
"source_settings": {"column_delimiter": ",",
"columns": ["k",
"v"
],
"encoding": "auto",
"file": {"bucket": "datasets",
"name": "source_e76242c4-8a93-4e91-b219-811488095d9b.csv",
"original_name": "kv.csv"
},
"json_documents": false,
"raw_content": false
},
"source_type": "table"
},
"summarization": null,
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
},
{"source": {"name": "Test simple file json",
"source_settings": {"default_loader": "TextLoader",
"extension_blacklist": [ ],
"extension_whitelist": [ ],
"file": {"bucket": "datasets",
"name": "source_13451092-b9b9-4c2e-a9e9-289473e4c38b.json",
"original_name": "policy.json"
},
"parse_tables_by_rows": false,
"split_pages": true
},
"source_type": "file"
},
"summarization": {"ai_integration_uid": "",
"ai_model_name": "gpt-35-turbo",
"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": true,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
},
{"source": {"name": "Test git",
"source_settings": {"branch": "stable",
"default_loader": "PythonLoader",
"extension_blacklist": [".pyc",
"..txt"
],
"extension_whitelist": [".py"
],
"multithreading": true,
"password": "Trump",
"url": "https://github.com/ProjectAlita/datasources.git",
"username": "Donald"
},
"source_type": "git"
},
"summarization": null,
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 6,
"strategy": "max_mmr_low"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
},
{"source": {"name": "Confluence test",
"source_settings": {"api_key": "12345678910",
"content_format": "anonymous",
"filter": "page_ids",
"filter_value": "10, 100",
"hosting_option": "cloud",
"include_attachments": true,
"max_total_pages": 100,
"pages_limit_per_request": 10,
"url": "https://kb.epam.com/",
"username": "Valera"
},
"source_type": "confluence"
},
"summarization": {"ai_integration_uid": "",
"ai_model_name": "gpt-35-turbo",
"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": true,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
},
{"source": {"name": "QTest test tautology",
"source_settings": {"columns": ["a"
],
"module_id": null,
"no_of_test_cases_per_page": 3,
"qtest_api_base_url": "https://www.testmo.com/",
"qtest_api_token": "abcdef_secret_token",
"qtest_project_id": 1000
},
"source_type": "qtest"
},
"summarization": {"ai_integration_uid": "",
"ai_model_name": "gpt-35-turbo",
"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": true,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": false,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}
],
"description": "Used for import/export testing",
"embedding_model": "",
"embedding_model_settings": {"model_name": ""
},
"name": "My Test Datasource of admin 1 (import)",
"storage": "",
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "development"
},
{"data": {"color": "red"
},
"name": "ai"
},
{"data": {"color": "red"
},
"name": "testing"
}
],
"context": "You are master kung fu of the pandas. Provide me some kick",
"conversation_starters": [ ],
"datasource_settings": {"chat": {"chat_settings_ai": null,
"chat_settings_embedding": {"cut_off_score": 0.5,
"fetch_k": 30,
"integration_uid": "",
"model_name": "",
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": null,
"search": null
},
"name": "latest",
"welcome_message": ""
}
]
}
]
}

export datasource

path Parameters

project_id

required

string

query Parameters

key	string
value	string
disabled	string

Responses

predict

path Parameters

project_id

required

string

Request Body schema: application/json

chat_history	Array of any
	object
	object
context	string
input	string

Responses

Request samples

Payload

Content type

application/json

{"chat_history": [ ],
"chat_settings_ai": {"integration_uid": "55109c7d-ded9-4c1c-b28e-531c93d2ffba",
"model_name": "gpt-4",
"temperature": 0.7,
"top_p": 0.5
},
"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "e5d50550-6edd-4a0c-98a6-c984f804b846",
"model_name": "sentence-transformers/all-MiniLM-L6-v2",
"page_top_k": 5,
"top_k": 20
},
"context": "jjj=456789",
"input": "aaa+jjj=?"
}

detail public datasource

Responses

public datasources

Responses

publish

path Parameters

project_id

required

string

Responses

search

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
	object
str_content	boolean

Responses

Request samples

Payload

Content type

application/json

{"chat_history": [{"content": "aaa+bbb=?",
"role": "user"
}
],
"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "a66d9576-b1be-411f-96f5-9920b4d35716",
"model_name": "sentence-transformers/all-mpnet-base-v2",
"page_top_k": 5,
"top_k": 20
},
"str_content": true
}

Response samples

200

Content type

application/json

{"findings": [{"metadata": {"source": "/tmp/tmpt12g5sbm/source_873c8715-5b9d-4747-8934-80d5c0edd198.csv"
},
"page_content": "\"{\\\"key\\\": \\\"aaa\\\", \\\"value\\\": \\\"1\\\"}\"",
"type": "Document"
},
{"metadata": {"source": "/tmp/tmpq1nhhnrn/source_2f4ec660-0a69-473c-a052-a85772c5a47c.csv"
},
"page_content": "key,value\naaa,1\nbbb,2\nccc,3\nddd,4\neee,555",
"type": "Document"
}
],
"references": ["/tmp/tmpq1nhhnrn/source_2f4ec660-0a69-473c-a052-a85772c5a47c.csv",
"/tmp/tmpt12g5sbm/source_873c8715-5b9d-4747-8934-80d5c0edd198.csv"
]
}

task stop

path Parameters

project_id required	string
datasource_id required	string

Responses

task_status

path Parameters

project_id

required

string

Responses

stop task predict

path Parameters

project_id

required

string

Responses

trending authors

path Parameters

public_project_id

required

string

Responses

unpublish

path Parameters

project_id

required

string

Responses

delete

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Responses

detail

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Responses

update

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Request Body schema: application/json

	Array of objects
name	string

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "black"
},
"name": "changed2"
}
],
"name": "latest"
}

list

path Parameters

project_id required	string
datasource_id required	string

Responses

create

path Parameters

project_id required	string
datasource_id required	string

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "new_version8"
}

datasets

delete

path Parameters

project_id

required

string

Responses

detail

path Parameters

project_id

required

string

Responses

update

path Parameters

project_id

required

string

Request Body schema: application/json

datasource_version_id	number
name	string
	object
source_type	string
summarization	string
transformers	object

Responses

Request samples

Payload

Content type

application/json

{"datasource_version_id": 1,
"name": "CHANGED",
"source_settings": {"key": "value"
},
"source_type": "gichanget",
"summarization": "row",
"transformers": { }
}

Response samples

200

Content type

application/json

{"created_at": "2024-03-27T12:17:22.009603",
"datasource_version": {"tags": [{"data": {"color": "red"
},
"name": "qa"
}
],
"author_id": 1,
"context": "",
"datasource_id": 1,
"datasource_settings": {"chat": {"chat_settings_ai": {"integration_uid": "6f65f628-840f-470d-af86-e0225e3fd18d",
"maximum_length": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_p": 0.5
},
"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2",
"page_top_k": 5,
"top_k": 20
}
},
"deduplicate": {"chat_settings_embedding": {"cut_off_score": 0.3,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2"
}
},
"search": {"chat_settings_embedding": {"cut_off_score": 0.3,
"fetch_k": 30,
"integration_uid": "87ed6538-486a-4a54-969a-654a0a8407db",
"model_name": "sentence-transformers/all-MiniLM-L6-v2",
"page_top_k": 5,
"top_k": 20
}
}
},
"name": "latest",
"shared_id": null,
"shared_owner_id": null,
"uuid": "36106f0b-0634-46e9-b6a7-ea60addfc50b"
},
"datasource_version_id": 1,
"id": 1,
"name": "kv",
"source_settings": {"column_delimiter": ",",
"columns": ["key",
"value"
],
"encoding": "auto",
"file": {"bucket": "datasets",
"name": "source_66e18571-1735-48a8-a09f-c3d915766d2c.csv",
"original_name": "test.csv"
},
"json_documents": true,
"raw_content": false
},
"source_type": "table",
"status": "running",
"summarization": {"ai_integration_uid": "",
"ai_model_name": "",
"chunk_summarization": false,
"chunk_summarization_prompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"document_summarization": false,
"document_summarization_prompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"task_id": "6022d598-3dbb-43f5-a783-f7741eadf9d1",
"transformers": {"extract_for_chunks": false,
"extract_for_document": false,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}

list

path Parameters

project_id

required

string

Responses

create Copy tmp

path Parameters

project_id

required

string

Request Body schema: application/json

datasource_version_id	number
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"datasource_version_id": 1,
"source": {"name": "arbiter datasource",
"options": {"advanced": {"default_loader": "PythonLoader",
"ext_blacklist": "",
"ext_whitelist": "",
"multithreading": false
},
"branch": "tasknode",
"password": "",
"ssh_key": "",
"type": "ssh",
"url": "https://github.com/carrier-io/arbiter.git",
"username": ""
},
"type": "git"
},
"summarization": {"chunkSummarization": false,
"chunkSummarizationPrompt": "CODE: {code} \n__________________________________________ \nSUMMARIZATION: {summarization}",
"documentSummarization": false,
"documentSummarizationPrompt": "You are acting as a code documentation expert for a project. Below is the code from a file that has the name '{fileName}'. Write a detailed technical explanation of what this code does. Create a constructor with a description of the input and output parameters of functions and objects Focus on the high-level purpose of the code and how it may be used in the larger project. Include code examples where appropriate. Keep you response between 100 and 300 words. DO NOT RETURN MORE THAN 300 WORDS. Output should be in markdown format. Do not just list the methods and classes in this file.\ncode: {fileContents}\nResponse:"
},
"transformers": {"extract_for_chunks": true,
"extract_for_document": true,
"extractor": "Bert",
"extractor_options": {"keyword_count": 5,
"strategy": "max_sum"
},
"split_by": "chunks",
"split_options": {"chunk_overlap": 100,
"chunk_size": 1000,
"regex": ""
}
}
}

task stop

path Parameters

project_id required	string
datasource_id required	string

Responses

task_status

path Parameters

project_id

required

string

Responses

applications

detail application

path Parameters

project_id

required

string

Responses

delete application

path Parameters

project_id required	string
application_version_id required	string

Responses

update application

path Parameters

project_id required	string
application_version_id required	string

Request Body schema: application/json

description	string
name	string
	object

Responses

Request samples

Payload

Content type

application/json

{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Vitae nibh turpis scelerisque commodo egestas id morbi urna in. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim",
"name": "My application UPD",
"version": {"tags": [{"data": {"color": "red"
},
"name": "changed1"
},
{"data": {"color": "white"
},
"name": "changed2"
},
{"data": {"color": "red"
},
"name": "changed3"
}
],
"conversation_starters": ["Changed starter"
],
"id": 2,
"instructions": "changed instructions",
"llm_settings": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"max_tokens": 800,
"model_name": "gpt-4",
"temperature": 1,
"top_k": 1,
"top_p": 0.2
},
"tools": [{"description": "Existing tool with id=1 will be changed",
"id": 1,
"name": "This will change existing tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
},
{"description": "New tool will be created because there is no id here",
"name": "This will create new tool",
"settings": {"custom_json": {"some": "value"
}
},
"type": "custom"
}
]
}
}

list applications

path Parameters

project_id

required

string

query Parameters

offset	string
limit	string
tags	string
sort_order	string
query	string

Responses

create application

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Vitae nibh turpis scelerisque commodo egestas id morbi urna in. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim",
"name": "My application",
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "tag1"
},
{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
}
],
"conversation_starters": ["Hello!",
"Hi, how are you?"
],
"instructions": "some instructions with ",
"llm_settings": {"integration_uid": "",
"max_tokens": 1000,
"model_name": "gpt-4",
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"name": "latest",
"tools": [{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}
],
"variables": [{"name": "var1",
"value": "VAR VALUE"
}
],
"welcome_message": "hi there!"
}
]
}

import application

path Parameters

project_id

required

string

Request Body schema: application/json

Array

collections	any or null
created_at	string
description	string
id	number
name	string
owner_id	number
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[{"collections": null,
"created_at": "2024-07-03T07:22:44.673767",
"description": "42",
"id": 3,
"name": "test42",
"owner_id": 2,
"versions": [{"tags": [ ],
"agent_type": "react",
"application_id": 3,
"author": {"avatar": null,
"email": "admin@centry.user",
"id": 2,
"name": "admin@centry.user"
},
"author_id": 2,
"conversation_starters": [ ],
"created_at": "2024-07-03T07:22:44.673767",
"id": 4,
"instructions": "test",
"llm_settings": {"integration_uid": "9d2b7232-bfaa-45e8-bee0-23760b67b2e2",
"max_tokens": 512,
"model_name": "gpt-35-turbo",
"temperature": 0.7,
"top_k": 20,
"top_p": 0.8
},
"name": "latest",
"status": "draft",
"tools": [{"description": "test",
"id": 9,
"name": "prompt",
"settings": {"prompt_id": 1,
"prompt_version_id": 2,
"variables": [ ]
},
"type": "prompt"
},
{"description": null,
"id": 8,
"name": "test",
"settings": {"authentication": {"settings": {"auth_type": "Basic"
},
"type": "api_key"
},
"schema_settings": "test",
"selected_tools": [ ]
},
"type": "openapi"
},
{"description": "test",
"id": 7,
"name": "jira",
"settings": {"additional_fields": "",
"base_url": "jira.com",
"cloud": true,
"limit": 5,
"selected_tools": ["search_using_jql",
"create_issue",
"update_issue",
"add_comments",
"list_projects",
"set_issue_status"
],
"username": "secret42",
"verify_ssl": true
},
"type": "jira"
},
{"description": "test",
"id": 6,
"name": "gitlab",
"settings": {"gitlab_personal_access_token": "some_sercret",
"gitlab_repository": "wrtw.git",
"gitlab_url": "test",
"main_branch": "main",
"selected_tools": ["create_branch",
"create_pull_request",
"create_file",
"delete_file",
"set_active_branch",
"list_branches_in_repo",
"get_pr_changes",
"create_pr_change_comment"
]
},
"type": "gitlab"
},
{"description": "test",
"id": 5,
"name": "github",
"settings": {"access_token": "secret42",
"active_branch": "main",
"repository": "git.com",
"selected_tools": ["get_issues",
"get_issue",
"comment_on_issue",
"list_open_pull_requests",
"get_pull_request",
"list_pull_request_files",
"create_pull_request",
"create_file",
"read_file",
"update_file",
"delete_file",
"list_files_in_main_branch",
"list_branches_in_repo",
"set_active_branch",
"create_branch",
"get_files_from_directory"
]
},
"type": "github"
},
{"description": "test dts",
"id": 4,
"name": "datasource",
"settings": {"datasource_id": 3,
"selected_tools": ["search",
"chat"
]
},
"type": "datasource"
},
{"description": "test",
"id": 3,
"name": "confluence",
"settings": {"api_key": "secret42",
"base_url": "test url",
"cloud": true,
"limit": 5,
"max_pages": 10,
"max_retry_seconds": 60,
"min_retry_seconds": 10,
"number_of_retries": 2,
"selected_tools": ["get_pages_with_label",
"search_pages",
"space"
],
"space": "space"
},
"type": "confluence"
},
{"description": "browser",
"id": 2,
"name": "browser",
"settings": {"selected_tools": ["wiki",
"single_url_crawler",
"multi_url_crawler",
"get_html_content",
"google"
]
},
"type": "browser"
},
{"description": "test app",
"id": 1,
"name": "Test Application",
"settings": {"application_id": 1,
"application_version_id": 1,
"variables": [ ]
},
"type": "application"
}
],
"variables": [ ],
"welcome_message": ""
}
]
}
]

export applications

path Parameters

project_id

required

string

query Parameters

as_file

string

Responses

predict

path Parameters

project_id

required

string

Request Body schema: text/plain

string <binary>

Responses

Response samples

200

Content type

application/json

{"error": null,
"messages": [{"content": "Tell me long story about JS",
"role": "user"
},
{"content": "Once upon a time, in the vast world of programming, there existed a powerful language known as JavaScript. JavaScript, often abbreviated as JS, was a programming language that enabled developers to add interactivity and dynamic behavior to websites. It played a crucial role in shaping the modern web that we know today.\n\nIn the early days, JavaScript was primarily used for simple tasks such as form validation or image rollovers. However, as the web evolved, so did JavaScript. It became more powerful, versatile, and capable of handling complex tasks.\n\nOne of the key features of JavaScript was its ability to manipulate the Document Object Model (DOM). The DOM represented the structure of a web page, and with JavaScript, developers could dynamically change its content, style, and behavior. This opened up a whole new world of possibilities.\n\nAs time went on, JavaScript became an integral part of web development. It was no longer limited to just the client-side. With the advent of Node.js, JavaScript could now be used on the server-side as well. This meant that developers could write JavaScript not only for the browser but also for the server, creating a more seamless and unified development experience.\n\nWith its growing popularity, the JavaScript ecosystem exploded. Countless libraries and frameworks were created to simplify and streamline the development process. From jQuery to React, Angular to Vue.js, developers had a wide range of tools at their disposal to build robust, scalable, and interactive web applications.\n\nJavaScript also found its way into mobile app development. With frameworks like React Native and Ionic, developers could write JavaScript code once and deploy it as a native app on multiple platforms, such as iOS and Android. This made it easier for developers to reach a wider audience and reduce development time and costs.\n\nBut JavaScript didn't stop at just the web and mobile. It also made its way into other areas such as game development, desktop applications, and even robotics. With frameworks like Phaser and Electron, developers could create immersive games and cross-platform desktop apps using JavaScript.\n\nThe community surrounding JavaScript was vibrant and continuously evolving. Online forums, communities, and conferences sprouted up, allowing developers to share knowledge, ask questions, and collaborate on projects. Open-source projects became commonplace, with developers contributing their time and expertise to improve the JavaScript ecosystem.\n\nAs JavaScript continued to evolve, new features and enhancements were added to the language. ES6 (ECMAScript 2015) introduced arrow functions, classes, modules, and many other improvements that made JavaScript code more concise and readable. Subsequent versions of ECMAScript brought even more features and enhancements, ensuring that JavaScript remained relevant and competitive in the ever-changing landscape of programming languages.\n\nIn conclusion, JavaScript had come a long way from its humble beginnings. From a simple scripting language to a powerful and versatile tool, JavaScript had revolutionized web development and beyond. Its ability to create dynamic and interactive experiences, its widespread adoption, and its vibrant community made it a force to be reckoned with. JavaScript had truly left an indelible mark on the world of programming, shaping the web and defining the modern era of technology. And so, the story of JavaScript continues, with new innovations and possibilities awaiting its users, both now and in the future.",
"role": "assistant"
}
]
}

detail public application

Responses

public applications

query Parameters

offset	string
limit	string
tags	string
sort_order	string

Responses

publish

path Parameters

project_id

required

string

Request Body schema: application/json

description	string
name	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Vitae nibh turpis scelerisque commodo egestas id morbi urna in. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim facilisis quis senectus a nunc habitasse blandit. Ornare egestas enim",
"name": "My application 2",
"versions": [{"tags": [{"data": {"color": "red"
},
"name": "tag1"
},
{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
}
],
"conversation_starters": ["Hello!"
],
"instructions": "some instructions with ",
"llm_settings": {"integration_uid": "",
"max_tokens": 1000,
"model_name": "gpt-4",
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"name": "latest",
"tools": [{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}
],
"variables": [{"name": "var1",
"value": "VAR VALUE"
}
]
}
]
}

stop task predict

path Parameters

project_id

required

string

Responses

update tool

path Parameters

project_id

required

string

Request Body schema: application/json

application_version_id	number
description	string
name	string
	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"application_version_id": 1,
"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Custom tool 3",
"settings": {"custom_json": {"test": 42
}
},
"type": "custom"
}

tool details

path Parameters

project_id

required

string

Responses

delete tool

path Parameters

project_id

required

string

Request Body schema: text/plain

string <binary>

Responses

create tool

path Parameters

project_id

required

string

Request Body schema: application/json

application_version_id	number
description	string
name	string
	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"application_version_id": 1,
"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}

list tools

path Parameters

application_version_id required	string
project_id required	string

Responses

trendings authors

path Parameters

public_project_id

required

string

Responses

unpublish

path Parameters

project_id

required

string

Responses

update

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
name	string

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "black"
},
"name": "changed3"
}
],
"name": "latest"
}

delete

path Parameters

project_id

required

string

Responses

detail

path Parameters

project_id

required

string

Responses

list

path Parameters

project_id

required

string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
conversation_starters	Array of strings
instructions	string
	object
name	string
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "red"
},
"name": "tag1"
},
{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
}
],
"conversation_starters": ["Hello!"
],
"instructions": "some instructions with ",
"llm_settings": {"integration_uid": "",
"max_tokens": 1000,
"model_name": "gpt-4",
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"name": "new4",
"tools": [{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}
],
"variables": [{"name": "var1",
"value": "VAR VALUE"
}
]
}

tools

update tool

path Parameters

project_id

required

string

Request Body schema: application/json

application_version_id	number
description	string
name	string
	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"application_version_id": 1,
"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Custom tool 3",
"settings": {"custom_json": {"test": 42
}
},
"type": "custom"
}

tool details

path Parameters

project_id

required

string

Responses

delete tool

path Parameters

project_id

required

string

Request Body schema: text/plain

string <binary>

Responses

create tool

path Parameters

project_id

required

string

Request Body schema: application/json

application_version_id	number
description	string
name	string
	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"application_version_id": 1,
"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}

list tools

path Parameters

application_version_id required	string
project_id required	string

Responses

chat

attach file

path Parameters

project_id

required

string

Request Body schema: application/octet-stream

string <binary>

Responses

conversation details

path Parameters

project_id

required

string

Responses

update conversations

path Parameters

project_id

required

string

Request Body schema: application/json

is_private	boolean
name	string

Responses

Request samples

Payload

Content type

application/json

{"is_private": true,
"name": "Test Name"
}

test

path Parameters

project_id

required

string

query Parameters

limit	string
offset	string
sort_by	string
sort_order	string desc/asc
query	string search filter

Responses

create conversation

path Parameters

project_id

required

string

Request Body schema: application/json

is_private	boolean
name	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"is_private": true,
"name": "New Conversation",
"participants": [{"entity_meta": {"integration_uid": "28c69e26-7fb7-43f1-ad25-7fb443a5ffc3",
"model_name": "gpt-35-turbo"
},
"entity_name": "llm",
"entity_settings": {"max_tokens": 512,
"temperature": 0.7,
"top_k": 20,
"top_p": 0.5
}
}
]
}

conversation delete

params: project_id: int, conversation_id: int, participant_id: int

path Parameters

project_id

required

string

Responses

update entity_settings

path Parameters

project_id

required

string

Request Body schema: application/json

test

number

Responses

Request samples

Payload

Content type

application/json

{"test": 42
}

add many participants

path Parameters

project_id

required

string

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"participants": [{"entity_meta": {"id": 99
},
"entity_name": "user",
"entity_settings": {"test": 42
},
"meta": { }
},
{"entity_meta": {"id": 100
},
"entity_name": "user",
"entity_settings": {"test": 54
},
"meta": { }
}
]
}

delete message

path Parameters

project_id required	string
prompt_version_id required	string

Responses

delete all messages

path Parameters

project_id required	string
prompt_version_id required	string

Request Body schema: text/plain

string <binary>

Responses

list messages

path Parameters

project_id required	string
prompt_version_id required	string

query Parameters

limit	string
offset	string
sort_by	string
sort_order	string desc/asc
query	string search filter

Responses

remove participant from conversation

path Parameters

project_id

required

string

Responses

add participant to conversation

path Parameters

project_id

required

string

Request Body schema: application/json

	object
entity_name	string
	object
meta	object

Responses

Request samples

Payload

Content type

application/json

{"entity_meta": {"id": 1
},
"entity_name": "application",
"entity_settings": {"var1": 1
},
"meta": { }
}

monitoring

notifications

deployments

ai_dial load modules

path Parameters

project_id

required

string

Request Body schema: application/json

api_base	string
	object
api_version	string
	object
is_default	boolean
mode	string
	Array of objects
project_id	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"api_base": "https://ai-proxy.lab.epam.com",
"api_token": {"from_secrets": false,
"value": "<token>"
},
"api_version": "2023-03-15-preview",
"config": {"name": "integration name"
},
"is_default": true,
"mode": "default",
"models": [{"capabilities": {"chat_completion": true,
"completion": false,
"embeddings": false
},
"id": "gpt-35-turbo",
"name": "gpt-35-turbo",
"token_limit": 8096
}
],
"project_id": "1",
"status": "success"
}

vertex_ai load modules

path Parameters

project_id

required

string

Request Body schema: application/json

	object
is_default	boolean
mode	string
models	Array of any
project	string
project_id	string
	object
status	string
zone	string

Responses

Request samples

Payload

Content type

application/json

{"config": {"name": "1"
},
"is_default": false,
"mode": "default",
"models": [ ],
"project": "rosy-clover-3945",
"project_id": "1",
"service_account_info": {"from_secrets": false,
"value": ""
},
"status": "success",
"zone": "us-central1"
}

load models

ai_dial load modules

path Parameters

project_id

required

string

Request Body schema: application/json

api_base	string
	object
api_version	string
	object
is_default	boolean
mode	string
	Array of objects
project_id	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"api_base": "https://ai-proxy.lab.epam.com",
"api_token": {"from_secrets": false,
"value": "<token>"
},
"api_version": "2023-03-15-preview",
"config": {"name": "integration name"
},
"is_default": true,
"mode": "default",
"models": [{"capabilities": {"chat_completion": true,
"completion": false,
"embeddings": false
},
"id": "gpt-35-turbo",
"name": "gpt-35-turbo",
"token_limit": 8096
}
],
"project_id": "1",
"status": "success"
}

vertex_ai load modules

path Parameters

project_id

required

string

Request Body schema: application/json

	object
is_default	boolean
mode	string
models	Array of any
project	string
project_id	string
	object
status	string
zone	string

Responses

Request samples

Payload

Content type

application/json

{"config": {"name": "1"
},
"is_default": false,
"mode": "default",
"models": [ ],
"project": "rosy-clover-3945",
"project_id": "1",
"service_account_info": {"from_secrets": false,
"value": ""
},
"status": "success",
"zone": "us-central1"
}

Api Mock

echo-get

path Parameters

project_id

required

string

query Parameters

arg1	string
arg2	string
status_code	string

Responses

unsecret

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
agent_type	string
application_id	number
	object
conversation_starters	Array of strings
created_at	string
id	number
instructions	string
	object
name	string
status	string
	Array of objects
	Array of objects
welcome_message	string

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "red"
},
"id": 1,
"name": "tag1"
},
{"data": {"color": "white"
},
"id": 2,
"name": "tag2"
},
{"data": {"color": "red"
},
"id": 3,
"name": "tag3"
}
],
"agent_type": "react",
"application_id": 1,
"author": {"avatar": null,
"email": "admin@centry.user",
"id": 3,
"name": "admin@centry.user"
},
"conversation_starters": ["Hello!"
],
"created_at": "2024-07-17T06:10:45.322504",
"id": 1,
"instructions": "some instructions with ",
"llm_settings": {"integration_uid": "868ad8e7-13a1-4bee-a154-0673c2143526",
"max_tokens": 1000,
"model_name": "gpt-4",
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"name": "latest",
"status": "draft",
"tools": [{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"id": 11,
"name": "Perfect tool",
"settings": {"branch": "main",
"private_token": "secret_TEST",
"repository": "test",
"selected_tools": [ ],
"url": "gitlab.com/1"
},
"type": "gitlab"
},
{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"id": 10,
"name": "Perfect tool",
"settings": {"branch": "main",
"private_token": "",
"repository": "test",
"selected_tools": [ ],
"url": "gitlab.com/1"
},
"type": "gitlab"
},
{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"id": 9,
"name": "Perfect tool",
"settings": {"branch": "main",
"private_token": "secret_TEST",
"repository": "test",
"selected_tools": [ ],
"url": "gitlab.com/1"
},
"type": "gitlab"
},
{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"id": 8,
"name": "Perfect tool",
"settings": {"branch": "main",
"private_token": "",
"repository": "test",
"selected_tools": [ ],
"url": "gitlab.com/1"
},
"type": "gitlab"
}
],
"variables": [{"id": 1,
"name": "var1",
"value": "VAR VALUE"
}
],
"welcome_message": ""
}

notification

path Parameters

project_id

required

string

Request Body schema: application/json

event_type	string
meta	object

Responses

Request samples

Payload

Content type

application/json

{"event_type": "some_event",
"meta": { }
}

trending_authors

path Parameters

project_id

required

string

Responses

versions12

update

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
name	string

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "black"
},
"name": "changed3"
}
],
"name": "latest"
}

delete

path Parameters

project_id

required

string

Responses

detail

path Parameters

project_id

required

string

Responses

list

path Parameters

project_id

required

string

Responses

create

path Parameters

project_id

required

string

Request Body schema: application/json

	Array of objects
conversation_starters	Array of strings
instructions	string
	object
name	string
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "red"
},
"name": "tag1"
},
{"data": {"color": "white"
},
"name": "tag2"
},
{"data": {"color": "red"
},
"name": "tag3"
}
],
"conversation_starters": ["Hello!"
],
"instructions": "some instructions with ",
"llm_settings": {"integration_uid": "",
"max_tokens": 1000,
"model_name": "gpt-4",
"temperature": 0.5,
"top_k": 2,
"top_p": 0.6
},
"name": "new4",
"tools": [{"description": "Ornare egestas enim facilisis quis senectus a nunc habitasse blandit",
"name": "Perfect tool",
"settings": {"actions": ["Chat",
"Search"
],
"datasource_id": 1
},
"type": "datasource"
}
],
"variables": [{"name": "var1",
"value": "VAR VALUE"
}
]
}

versions1

detail

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Responses

update

path Parameters

project_id required	string
datasource_id required	string
datasource_version_id required	string

Request Body schema: application/json

	Array of objects
name	string

Responses

Request samples

Payload

Content type

application/json

{"tags": [{"data": {"color": "black"
},
"name": "changed2"
}
],
"name": "latest"
}

list

path Parameters

project_id required	string
datasource_id required	string

Responses

create

path Parameters

project_id required	string
datasource_id required	string

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "new_version8"
}

moderation

recently approved

Responses

approve

Responses

reject

Responses

authors

author

Responses

trending authors

path Parameters

public_project_id

required

string

Responses

social

dislike entity

path Parameters

public_project_id

required

string

Responses

like entity

path Parameters

public_project_id

required

string

Responses

like

dislike entity

path Parameters

public_project_id

required

string

Responses

like entity

path Parameters

public_project_id

required

string

Responses

legacy

list [old]

path Parameters

project_id

required

string

Responses

create [old]

path Parameters

project_id

required

string

Request Body schema: application/json

name	string
prompt	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"name": "test_old",
"prompt": "test old",
"type": "chat"
}