Skip to main content

​
synth_ai.research.factories

client.research.factories — Factory domain (Tag under factories.tag).

​
Classes

​
ResearchFactoriesTagSessionsMessagesAPI

Send steering messages to an active Factory Tag session. Methods:

​
send 

send(self, session_id: str, message: TagMessageRequest | Mapping[str, Any] | dict[str, Any] | str) -> TagSession
Post a message to a Tag session and return the updated session state. Args:
  • session_id: Tag session id from sessions.create.
  • message: TagMessageRequest, mapping, or plain string body.
  • metadata: Optional message metadata.
  • idempotency_key: Optional idempotency key for safe retries.
Returns:
  • Updated TagSession after the message is accepted.

​
ResearchFactoriesTagSessionsAPI

Create and inspect Factory Tag sessions. Methods:

​
messages 

messages(self) -> ResearchFactoriesTagSessionsMessagesAPI
Nested API for sending Tag session messages.

​
create 

create(self, request: TagSessionCreateRequest | Mapping[str, Any] | dict[str, Any] | str) -> TagSession
Start a Factory Tag session for a one-off research task. Args:
  • request: TagSessionCreateRequest, mapping, or primary request string shown to the Tag worker.
  • definition_of_done: Optional explicit DoD text.
  • scope_id: Optional Tag scope override (defaults via scopes).
  • timebox_seconds: Optional wall-clock cap for the session.
  • runbook_preset: Optional runbook preset slug.
  • metadata: Optional session metadata.
Returns:
  • Created TagSession with ids needed for messages.send.

​
get 

get(self, session_id: str) -> TagSession
Fetch the current Tag session state and terminal receipt fields.

​
ResearchFactoriesTagScopesAPI

Resolve default Tag scopes for an organization. Methods:

​
get_default 

get_default(self) -> TagScope
Return the org default Tag scope used when scope_id is omitted.

​
ResearchFactoriesTagAPI

Factory Tag namespace — delegate short research tasks from your IDE. Methods:

​
sessions 

sessions(self) -> ResearchFactoriesTagSessionsAPI
Create Tag sessions and send steering messages.

​
scopes 

scopes(self) -> ResearchFactoriesTagScopesAPI
Read Tag scope defaults for the org.

​
ResearchFactoriesAPI

Factory domain namespace (Tag ships under factories.tag). Methods:

​
tag 

tag(self) -> ResearchFactoriesTagAPI
Factory Tag — short-lived delegated research sessions.