Analysis

Run a tool using session entries

Run any SeqBench tool, resolving selected arguments from a session's named entries instead of pasting them inline, and optionally store selected result fields back into the session by name. This is the main way to chain a multi-part design (vector + insert + primers) across calls without shuttling raw sequences through your own context.

post/session_run

Request

  • Base URL: https://seqbench.com/api/v1
  • URL: https://seqbench.com/api/v1/session_run
  • Auth: none required

Request body

sessionIdstring required
toolstring required

Name of any non-meta SeqBench tool (not batch, workflow, or another session_* tool).

fromSessionobject

Map of { toolArgName: sessionEntryName } — resolves each named tool argument from the session before running.

argsobject

Additional literal arguments, merged with the ones resolved from the session.

writeBackobject

Map of { resultFieldName: sessionEntryName } — stores selected fields of the result back into the session under these names.

Response

Tool ran successfully.

okunknown required
toolstring required

The tool slug that ran.

resultobject required

Tool-specific output object. Its shape depends on the tool — call GET /{tool} or see the docs for each tool's fields.

Example response

{
  "provenance": {
    "apiVersion": "1.1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.