Skip to content

Tool

get(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of tools.

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get tool details

body

exception message

Returns:

A Dictionary with

    - "entities" as key , (List[Tool]) as value

    - "total" as key : record count as value

list(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of tools.

Parameters:

Name Type Description Default
body EntitiesListRequest

A list of requested entities. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get tool list

body

exception message

Returns:

A Dictionary with

    - "entities" as key , (List[Tool]) as value

    - "total" as key : record count as value

save(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Save or update a Tool.

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get Tool details

body

exception message

Returns:

Name Type Description
Tool Tool

The new or updated Tool