native
Class info¶
Classes¶
| Name | Children | Inherits |
|---|---|---|
| ApprovalOption pyt3client.native.models A choice an approval request offers (`ProviderApprovalOption`). |
||
| DomainEvent pyt3client.native.models A thread event (`OrchestrationV2DomainEvent`); `payload` depends on `type`. |
||
| NativeItemRef pyt3client.native.models The provider's own id of what an item stands for (`OrchestrationV2ProviderRef`). |
||
| RpcSocket pyt3client.native.rpc Requests and streams over one Effect RPC WebSocket; many may run at once. |
||
| Run pyt3client.native.models A run of a thread (`run.created` / `run.updated`). |
||
| RuntimeRequest pyt3client.native.models An approval or question a provider waits on (`OrchestrationV2RuntimeRequest`). |
||
| T3NativeClient pyt3client.native.client One socket to an environment's native RPC; subscriptions and commands share it. |
||
| ThreadEvent pyt3client.native.models One event of the thread, in `sequence` order. |
||
| ThreadSnapshot pyt3client.native.models The thread as it is when the subscription starts; events continue after it. |
||
| ThreadSynchronized pyt3client.native.models The subscription caught up with the thread. |
||
| TurnItem pyt3client.native.models A timeline row (`OrchestrationV2TurnItem`): a message, reasoning, tool work, a request. |
||
| UnknownStreamItem pyt3client.native.models A stream item of a kind this client does not know (newer servers). |
🛈 DocStrings¶
T3 Code's native surface: the WebSocket RPC its web, desktop and mobile clients use.
Unlike /mcp, it streams a thread's events as they happen and can answer
approvals. It needs its own sign-in (see sign_in_native); install the native
extra (pip install pyt3client[native]) for the WebSocket dependency.
from pyt3client.native import T3NativeClient, sign_in_native
credentials = await sign_in_native("http://127.0.0.1:3773", "PAIRING-TOKEN")
async with T3NativeClient.from_credentials(credentials) as t3:
async for item in t3.subscribe_thread(thread_id):
...
ApprovalDecision
¶
ApprovalDecision = Literal['accept', 'acceptForSession', 'acceptAlways', 'decline', 'cancel']
ProviderApprovalDecision (upstream packages/contracts/src/providerPolicy.ts).
ApprovalOption
¶
Bases: _Open
A choice an approval request offers (ProviderApprovalOption).
Source code in src/pyt3client/native/models.py
34 35 36 37 38 39 | |
DomainEvent
¶
Bases: _Open
A thread event (OrchestrationV2DomainEvent); payload depends on type.
Source code in src/pyt3client/native/models.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
run
¶
run() -> Run | None
The run of a run.created or run.updated event.
Source code in src/pyt3client/native/models.py
122 123 124 125 126 | |
runtime_request
¶
runtime_request() -> RuntimeRequest | None
The request of a runtime-request.updated event.
Source code in src/pyt3client/native/models.py
128 129 130 131 132 | |
turn_item
¶
turn_item() -> TurnItem | None
The item of a turn-item.updated event.
Source code in src/pyt3client/native/models.py
116 117 118 119 120 | |
NativeItemRef
¶
Bases: _Open
The provider's own id of what an item stands for (OrchestrationV2ProviderRef).
An approval request shares it with the tool call it is about.
Source code in src/pyt3client/native/models.py
42 43 44 45 46 47 48 49 | |
RpcSocket
¶
Requests and streams over one Effect RPC WebSocket; many may run at once.
Use RpcSocket.connect(url). Each request gets its own id; a reader task routes
the server's frames to the request they answer.
Source code in src/pyt3client/native/rpc.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
call
async
¶
call(tag: str, payload: Mapping[str, JsonValue]) -> JsonValue
Send a request and return its result.
Raises:
| Type | Description |
|---|---|
T3RpcError
|
The request failed, or the socket closed before it ended. |
Source code in src/pyt3client/native/rpc.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | |
connect
async
classmethod
¶
connect(url: str) -> AsyncGenerator[RpcSocket]
Open the socket at url (with its wsTicket) and close it on exit.
Source code in src/pyt3client/native/rpc.py
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
stream
async
¶
stream(tag: str, payload: Mapping[str, JsonValue]) -> AsyncIterator[JsonValue]
Send a streaming request and yield its items until the server ends it.
Leaving the loop early interrupts the request on the server.
Raises:
| Type | Description |
|---|---|
T3RpcError
|
The request failed, or the socket closed before it ended. |
Source code in src/pyt3client/native/rpc.py
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | |
Run
¶
Bases: _Open
A run of a thread (run.created / run.updated).
Source code in src/pyt3client/native/models.py
88 89 90 91 92 93 94 95 | |
status
instance-attribute
¶
status: str
preparing, queued, starting, running, waiting, completed,
interrupted, failed, cancelled or rolled_back.
RuntimeRequest
¶
Bases: _Open
An approval or question a provider waits on (OrchestrationV2RuntimeRequest).
Source code in src/pyt3client/native/models.py
98 99 100 101 102 103 104 105 | |
kind
instance-attribute
¶
kind: str
A ProviderRequestKind, or dynamic_tool_call, user_input, auth_refresh.
T3NativeClient
¶
One socket to an environment's native RPC; subscriptions and commands share it.
async with T3NativeClient.from_credentials(credentials) as t3:
async for item in t3.subscribe_thread(thread_id):
...
Source code in src/pyt3client/native/client.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | |
dispatch
async
¶
dispatch(command: Mapping[str, JsonValue]) -> int
Run an orchestration command (dispatchCommand); returns its event sequence.
command is an OrchestrationV2Command (upstream orchestrationV2.ts), such
as {"type": "thread.interrupt", "threadId": ...}; a commandId is added
when missing.
Raises:
| Type | Description |
|---|---|
T3RpcError
|
The command was refused. |
Source code in src/pyt3client/native/client.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
respond_to_request
async
¶
respond_to_request(
thread_id: str,
request_id: str,
*,
decision: ApprovalDecision | None = None,
answers: Mapping[str, JsonValue] | None = None,
feedback: str | None = None
) -> int
Answer an approval (decision) or a question (answers) a thread waits on.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
thread_id
|
str
|
The thread. |
required |
request_id
|
str
|
The runtime request ( |
required |
decision
|
ApprovalDecision | None
|
For approvals. |
None
|
answers
|
Mapping[str, JsonValue] | None
|
For questions: question id -> answer. |
None
|
feedback
|
str | None
|
Text sent along with the decision, where the provider takes it. |
None
|
Source code in src/pyt3client/native/client.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | |
subscribe_thread
async
¶
subscribe_thread(
thread_id: str, *, after_sequence: int | None = None
) -> AsyncIterator[ThreadStreamItem]
The thread's snapshot, then its events as they happen (subscribeThread).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
thread_id
|
str
|
The thread to follow. |
required |
after_sequence
|
int | None
|
Resume after this event (a snapshot's |
None
|
Source code in src/pyt3client/native/client.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | |
ThreadEvent
¶
Bases: _Open
One event of the thread, in sequence order.
Source code in src/pyt3client/native/models.py
144 145 146 147 148 149 | |
ThreadSnapshot
¶
Bases: _Open
The thread as it is when the subscription starts; events continue after it.
Source code in src/pyt3client/native/models.py
135 136 137 138 139 140 141 | |
projection
instance-attribute
¶
projection: dict[str, JsonValue]
OrchestrationV2ThreadProjection: thread, runs, turn items, requests, ...
ThreadSynchronized
¶
Bases: _Open
The subscription caught up with the thread.
Source code in src/pyt3client/native/models.py
152 153 154 155 | |
TurnItem
¶
Bases: _Open
A timeline row (OrchestrationV2TurnItem): a message, reasoning, tool work, a request.
type is e.g. user_message, assistant_message, reasoning, command_execution,
file_change, dynamic_tool, approval_request, user_input_request,
checkpoint. status is one of idle, pending, running, waiting,
completed, interrupted, failed, cancelled, rolled_back.
Source code in src/pyt3client/native/models.py
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
options
class-attribute
instance-attribute
¶
options: list[ApprovalOption] | None = None
For approval_request: the decisions on offer, when the provider names them.
prompt
class-attribute
instance-attribute
¶
prompt: str | None = None
For approval_request: what is to be approved, such as the command.
request_id
class-attribute
instance-attribute
¶
request_id: str | None = None
For approval_request and user_input_request: the runtime request to answer.
request_kind
class-attribute
instance-attribute
¶
request_kind: str | None = None
For approval_request: command, file-read, file-change, mcp-elicitation
or permission (ProviderRequestKind).
text
class-attribute
instance-attribute
¶
text: str | None = None
Text of message and reasoning items; complete once streaming is false.
UnknownStreamItem
¶
Bases: _Open
A stream item of a kind this client does not know (newer servers).
Source code in src/pyt3client/native/models.py
158 159 160 161 | |
parse_stream_item
¶
parse_stream_item(value: JsonValue) -> ThreadStreamItem
A subscribeThread stream value as a model.
Raises:
| Type | Description |
|---|---|
ValidationError
|
A known kind with an unexpected shape. |
Source code in src/pyt3client/native/models.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | |
sign_in_native
async
¶
sign_in_native(
base_url: str,
pairing_token: str,
*,
label: str = "pyt3client",
scopes: Sequence[str] | None = None,
http_client: AsyncClient | None = None
) -> T3NativeCredentials
Exchange a one-time pairing token for a native bearer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base_url
|
str
|
Environment origin, such as |
required |
pairing_token
|
str
|
The pairing token's credential (it can be used once). |
required |
label
|
str
|
Client name shown in T3 Code under Settings -> Sharing & access. |
'pyt3client'
|
scopes
|
Sequence[str] | None
|
Scopes to ask for, at most those of the pairing token; all of them when omitted. |
None
|
http_client
|
AsyncClient | None
|
Client to reuse; a short-lived one is created otherwise. |
None
|
Raises:
| Type | Description |
|---|---|
T3AuthError
|
The pairing token was refused (used, expired or revoked). |
Source code in src/pyt3client/native/client.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | |
websocket_url
async
¶
websocket_url(base_url: str, access_token: str, *, http_client: AsyncClient | None = None) -> str
The URL of a new socket, with a fresh one-time ticket.
Raises:
| Type | Description |
|---|---|
T3AuthError
|
The bearer was refused (revoked, expired, or an MCP token). |
Source code in src/pyt3client/native/client.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |