timeweb_cloud_api.AIAgentsApi

All URIs are relative to https://api.timeweb.cloud

Method	HTTP request	Description
add_additional_token_package	POST /api/v1/cloud-ai/agents/{id}/add-additional-token-package	Добавление дополнительного пакета токенов
create_agent	POST /api/v1/cloud-ai/agents	Создание AI агента
delete_agent	DELETE /api/v1/cloud-ai/agents/{id}	Удаление AI агента
get_agent	GET /api/v1/cloud-ai/agents/{id}	Получение AI агента
get_agent_statistics	GET /api/v1/cloud-ai/agents/{id}/statistic	Получение статистики использования токенов агента
get_agents	GET /api/v1/cloud-ai/agents	Получение списка AI агентов
get_agents_token_packages	GET /api/v1/cloud-ai/token-packages/agents	Получение списка пакетов токенов для агентов
get_knowledgebases_token_packages	GET /api/v1/cloud-ai/token-packages/knowledge-bases	Получение списка пакетов токенов для баз знаний
get_models	GET /api/v1/cloud-ai/models	Получение списка моделей
update_agent	PATCH /api/v1/cloud-ai/agents/{id}	Обновление AI агента

add_additional_token_package

add_additional_token_package(id, add_token_package=add_token_package)

Добавление дополнительного пакета токенов

Чтобы добавить дополнительный пакет токенов для AI агента, отправьте POST-запрос на /api/v1/cloud-ai/agents/{id}/add-additional-token-package.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.add_token_package import AddTokenPackage
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    id = 1 # object | ID агента
    add_token_package = timeweb_cloud_api.AddTokenPackage() # AddTokenPackage |  (optional)

    try:
        # Добавление дополнительного пакета токенов
        api_instance.add_additional_token_package(id, add_token_package=add_token_package)
    except Exception as e:
        print("Exception when calling AIAgentsApi->add_additional_token_package: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	object	ID агента
add_token_package	AddTokenPackage		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Дополнительный пакет токенов успешно добавлен	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_agent

CreateAgent201Response create_agent(create_agent)

Создание AI агента

Чтобы создать AI агента, отправьте POST-запрос на /api/v1/cloud-ai/agents, задав необходимые атрибуты. Агент будет создан с использованием предоставленной информации. Тело ответа будет содержать объект JSON с информацией о созданном агенте.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.create_agent import CreateAgent
from timeweb_cloud_api.models.create_agent201_response import CreateAgent201Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    create_agent = timeweb_cloud_api.CreateAgent() # CreateAgent | 

    try:
        # Создание AI агента
        api_response = api_instance.create_agent(create_agent)
        print("The response of AIAgentsApi->create_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->create_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_agent	CreateAgent

Return type

CreateAgent201Response

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Объект JSON c ключом `agent`	-
400		-
401		-
403		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_agent

delete_agent(id)

Удаление AI агента

Чтобы удалить AI агента, отправьте DELETE-запрос на /api/v1/cloud-ai/agents/{id}.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    id = 1 # object | ID агента

    try:
        # Удаление AI агента
        api_instance.delete_agent(id)
    except Exception as e:
        print("Exception when calling AIAgentsApi->delete_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	object	ID агента

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	AI агент успешно удален	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent

CreateAgent201Response get_agent(id)

Получение AI агента

Чтобы получить информацию об AI агенте, отправьте GET-запрос на /api/v1/cloud-ai/agents/{id}.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.create_agent201_response import CreateAgent201Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    id = 1 # object | ID агента

    try:
        # Получение AI агента
        api_response = api_instance.get_agent(id)
        print("The response of AIAgentsApi->get_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	object	ID агента

Return type

CreateAgent201Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключом `agent`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_statistics

GetAgentStatistics200Response get_agent_statistics(id, start_time=start_time, end_time=end_time, interval=interval)

Получение статистики использования токенов агента

Чтобы получить статистику использования токенов AI агента, отправьте GET-запрос на /api/v1/cloud-ai/agents/{id}/statistic. Можно указать временной диапазон и интервал агрегации.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.get_agent_statistics200_response import GetAgentStatistics200Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    id = 1 # object | ID агента
    start_time = 2024-10-01T00:00:00.000Z # object | Начало временного диапазона (ISO 8601) (optional)
    end_time = 2024-10-16T23:59:59.999Z # object | Конец временного диапазона (ISO 8601) (optional)
    interval = 60 # object | Интервал в минутах (по умолчанию 60) (optional)

    try:
        # Получение статистики использования токенов агента
        api_response = api_instance.get_agent_statistics(id, start_time=start_time, end_time=end_time, interval=interval)
        print("The response of AIAgentsApi->get_agent_statistics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_agent_statistics: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	object	ID агента
start_time	object	Начало временного диапазона (ISO 8601)	[optional]
end_time	object	Конец временного диапазона (ISO 8601)	[optional]
interval	object	Интервал в минутах (по умолчанию 60)	[optional]

Return type

GetAgentStatistics200Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключами `agent_statistics` и `meta`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agents

GetAgents200Response get_agents()

Получение списка AI агентов

Чтобы получить список AI агентов, отправьте GET-запрос на /api/v1/cloud-ai/agents. Тело ответа будет представлять собой объект JSON с ключом agents.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.get_agents200_response import GetAgents200Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)

    try:
        # Получение списка AI агентов
        api_response = api_instance.get_agents()
        print("The response of AIAgentsApi->get_agents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_agents: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetAgents200Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключами `agents` и `meta`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agents_token_packages

GetAgentsTokenPackages200Response get_agents_token_packages()

Получение списка пакетов токенов для агентов

Чтобы получить список доступных пакетов токенов для AI агентов, отправьте GET-запрос на /api/v1/cloud-ai/token-packages/agents. Тело ответа будет представлять собой объект JSON с ключом token_packages.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.get_agents_token_packages200_response import GetAgentsTokenPackages200Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)

    try:
        # Получение списка пакетов токенов для агентов
        api_response = api_instance.get_agents_token_packages()
        print("The response of AIAgentsApi->get_agents_token_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_agents_token_packages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetAgentsTokenPackages200Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключами `token_packages` и `meta`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_knowledgebases_token_packages

GetAgentsTokenPackages200Response get_knowledgebases_token_packages()

Получение списка пакетов токенов для баз знаний

Чтобы получить список доступных пакетов токенов для баз знаний, отправьте GET-запрос на /api/v1/cloud-ai/token-packages/knowledge-bases. Тело ответа будет представлять собой объект JSON с ключом token_packages.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.get_agents_token_packages200_response import GetAgentsTokenPackages200Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)

    try:
        # Получение списка пакетов токенов для баз знаний
        api_response = api_instance.get_knowledgebases_token_packages()
        print("The response of AIAgentsApi->get_knowledgebases_token_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_knowledgebases_token_packages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetAgentsTokenPackages200Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключами `token_packages` и `meta`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_models

GetModels200Response get_models()

Получение списка моделей

Чтобы получить список доступных AI моделей, отправьте GET-запрос на /api/v1/cloud-ai/models. Тело ответа будет представлять собой объект JSON с ключом models.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.get_models200_response import GetModels200Response
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)

    try:
        # Получение списка моделей
        api_response = api_instance.get_models()
        print("The response of AIAgentsApi->get_models:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->get_models: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetModels200Response

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключами `models` и `meta`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_agent

CreateAgent201Response update_agent(id, update_agent)

Обновление AI агента

Чтобы обновить AI агента, отправьте PATCH-запрос на /api/v1/cloud-ai/agents/{id}.

Example

Bearer (JWT) Authentication (Bearer):

import time
import os
import timeweb_cloud_api
from timeweb_cloud_api.models.create_agent201_response import CreateAgent201Response
from timeweb_cloud_api.models.update_agent import UpdateAgent
from timeweb_cloud_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.timeweb.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = timeweb_cloud_api.Configuration(
    host = "https://api.timeweb.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = timeweb_cloud_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with timeweb_cloud_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = timeweb_cloud_api.AIAgentsApi(api_client)
    id = 1 # object | ID агента
    update_agent = timeweb_cloud_api.UpdateAgent() # UpdateAgent | 

    try:
        # Обновление AI агента
        api_response = api_instance.update_agent(id, update_agent)
        print("The response of AIAgentsApi->update_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAgentsApi->update_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	object	ID агента
update_agent	UpdateAgent

Return type

CreateAgent201Response

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Объект JSON c ключом `agent`	-
400		-
401		-
403		-
404		-
429		-
500		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

AIAgentsApi.md

Latest commit

History

AIAgentsApi.md

File metadata and controls

timeweb_cloud_api.AIAgentsApi

add_additional_token_package

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_statistics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agents_token_packages

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_knowledgebases_token_packages

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_models

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details