For the complete documentation index, see llms.txt. This page is also available as Markdown.

Methods

Every EdisonClient method, grouped by area. Each group lists the synchronous methods and their a-prefixed asynchronous twins. Async twins take the same arguments and return the same types — just await them.

Anywhere a model such as TaskRequest is accepted, you can also pass a plain dict with the same fields — it's validated into the model for you. Both argument payloads and return values are shown below as example JSON; sample values are placeholders.

Tasks

Sync

run_tasks_until_done()

Run multiple tasks and wait for them to complete.

run_tasks_until_done(
    task_data: TaskRequest | Collection[TaskRequest],
    verbose: bool = False,
    progress_bar: bool = False,
    timeout: float | None = 2400,
    files: list[str] | None = None,
) -> list[LiteTaskResponse | TaskResponse | TaskResponseVerbose]

Arguments

{
  "task_data": {
    "task_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
    "project_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
    "persona_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
    "name": "string",
    "query": "string",
    "runtime_config": {
      "timeout": 0,
      "max_steps": 0,
      "agent": null,
      "environment_config": {},
      "continued_job_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
      "world_model_id": "019cd179-8d61-7f65-a79c-b965dda9eac3"
    },
    "caller_target_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
    "caller_project_id": "019cd179-8d61-7f65-a79c-b965dda9eac3",
    "tags": [
      "string"
    ],
    "workspace_id": "string"
  },
  "verbose": false,
  "progress_bar": false,
  "timeout": 2400,
  "files": null
}

Returns list[LiteTaskResponse | TaskResponse | TaskResponseVerbose] — each element is one of:

LiteTaskResponse

TaskResponse

TaskResponseVerbose

create_task()

Create a new futurehouse task.

Arguments

Returns str — The new task's trajectory_id.

get_task()

Get details for a specific task.

Returns TaskResponse | TaskResponseVerbose | LiteTaskResponse — one of:

TaskResponse

TaskResponseVerbose

LiteTaskResponse

get_tasks()

Fetches trajectories with applied filtering.

Arguments

Returns list[dict[str, Any]]

Raw, unvalidated dicts (no Pydantic model).

cancel_task()

Cancel a specific task/trajectory.

Returns bool

delete_trajectory()

Delete a trajectory (soft delete - marks as hidden).

Returns nothing (None).

Async

arun_tasks_until_done()

Awaitable twin of run_tasks_until_done() — identical arguments and return type.

acreate_task()

Awaitable twin of create_task() — identical arguments and return type.

aget_task()

Awaitable twin of get_task() — identical arguments and return type.

aget_tasks()

Awaitable twin of get_tasks() — identical arguments and return type.

adelete_trajectory()

Awaitable twin of delete_trajectory() — identical arguments and return type.

Data Storage

Sync

store_file_content()

Store file or directory content in the data storage system.

Returns DataStorageResponse

store_text_content()

Store content as a string in the data storage system.

Returns DataStorageResponse

store_link()

Store a link/URL in the data storage system.

Returns DataStorageResponse

fetch_data_from_storage()

Fetch data from the storage system.

Returns RawFetchResponse | Path | list[Path] | None — one of:

RawFetchResponse

Path"/local/path/to/file"

list[Path]["/local/path/to/file"]

Nonenull (e.g. not found / empty)

get_data_storage_entry()

Get a data storage entry with all details including storage locations and metadata.

Returns DataStorageResponse

delete_data_storage_entry()

Delete a data storage entry.

Returns nothing (None).

search_data_storage()

Search data storage objects using structured criteria.

Arguments

Returns list[dict]

Raw, unvalidated dicts (no Pydantic model).

similarity_search_data_storage()

Search data storage objects using vector similarity.

Returns list[dict]

Raw, unvalidated dicts (no Pydantic model).

update_entry_permissions()

Update the permissions of a data storage entry.

Arguments

Returns DataStorageResponse

update_entry_tags()

Update the tags of a data storage entry.

Returns DataStorageResponse

Async

astore_file_content()

Awaitable twin of store_file_content() — identical arguments and return type.

astore_text_content()

Awaitable twin of store_text_content() — identical arguments and return type.

astore_link()

Awaitable twin of store_link() — identical arguments and return type.

afetch_data_from_storage()

Awaitable twin of fetch_data_from_storage() — identical arguments and return type.

aget_data_storage_entry()

Awaitable twin of get_data_storage_entry() — identical arguments and return type.

adelete_data_storage_entry()

Awaitable twin of delete_data_storage_entry() — identical arguments and return type.

asearch_data_storage()

Awaitable twin of search_data_storage() — identical arguments and return type.

asimilarity_search_data_storage()

Awaitable twin of similarity_search_data_storage() — identical arguments and return type.

aupdate_entry_permissions()

Awaitable twin of update_entry_permissions() — identical arguments and return type.

aupdate_entry_tags()

Awaitable twin of update_entry_tags() — identical arguments and return type.

Projects

Sync

create_project()

Create a new project.

Arguments

Returns UUID

get_project_by_name()

Get a project UUID by name.

Returns UUID | list[UUID] — one of:

UUID"019cd179-8d61-7f65-a79c-b965dda9eac3"

list[UUID]["019cd179-8d61-7f65-a79c-b965dda9eac3"]

add_task_to_project()

Add a task to a project. Use this to assign or reassign a task to a project.

Returns nothing (None).

delete_project()

Delete a project.

Returns nothing (None).

Async

acreate_project()

Awaitable twin of create_project() — identical arguments and return type.

aget_project_by_name()

Awaitable twin of get_project_by_name() — identical arguments and return type.

aadd_task_to_project()

Awaitable twin of add_task_to_project() — identical arguments and return type.

adelete_project()

Awaitable twin of delete_project() — identical arguments and return type.

Last updated