Tools API.¶

The DeepOriginClient can be used to access the tools API using:

from deeporigin.platform.client import DeepOriginClient

client = DeepOriginClient()

Then, the following methods can be used, for example:

tools = client.executions.list()

src.platform.executions.Executions ¶

Executions API wrapper.

Provides access to tool execution-related endpoints through the DeepOriginClient.

cancel(*, execution_id: str) -> None

Cancel a tool execution.

Parameters:

Name	Type	Description	Default
`execution_id`	`str`	The execution ID to cancel.	required

Returns:

Type	Description
`None`	None. If the execution is already in a terminal state, returns early.

confirm(*, execution_id: str) -> None

Confirm a tool execution.

Parameters:

Name	Type	Description	Default
`execution_id`	`str`	The execution ID to confirm.	required

Returns:

Type	Description
`None`	None.

get_execution(*, execution_id: str) -> dict

Get a tool execution by execution ID.

Parameters:

Name	Type	Description	Default
`execution_id`	`str`	The execution ID to get.	required

Returns:

Type	Description
`dict`	Dictionary containing the tool execution data.

get_status(*, execution_id: str) -> str

Get the status of a tool execution.

Parameters:

Name	Type	Description	Default
`execution_id`	`str`	The execution ID to get the status for.	required

Returns:

Type	Description
`str`	The status string, e.g., "Created", "Queued", "Running", "Succeeded", or "Failed".

list(
    *,
    page: int | None = None,
    page_size: int | None = None,
    order: str | None = None,
    filter: str | None = None
) -> dict

List tool executions with pagination and filtering.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	Page number of the pagination (default 0).	`None`
`page_size`	`int \| None`	Page size of the pagination (max 10,000).	`None`
`order`	`str \| None`	Order of the pagination, e.g., "executionId? asc", "completedAt? desc".	`None`
`filter`	`str \| None`	Filter applied to the data set Execution Model.	`None`

Returns:

Type	Description
`dict`	Dictionary containing paginated execution data.