Streams

Streams

@toothfairyai/sdk@latest…

Accessed via client.streams.

Methods

Method	HTTP	Endpoint
get	GET	GET /stream/get/{id}
list	GET	GET /stream/list

get

async get(id: string)

Endpoint: GET /stream/get/{id} · API service

Response fields

Field	Type	Description
id	string	Unique identifier for the output stream
content	string	Generated output content text
t_content	string	Translated version of the output content
prompt	string	The prompt that generated this output
t_prompt	string	Translated version of the prompt
workspaceID	string	Unique workspace identifier (UUID v4)
type	string	Type classification (free-form string identifier)

Allowed: translator, answerer, parser, tokenizer, embedder, detector, questioner, generator, chatter, planner, analyser | | status | string | Current status of the resource

Allowed: success, failed, timeout, fulfilled, pending, inProgress, cancelled, awaitingUserInput, continued, ingested | | humanFeedback | string | Human feedback on the message: positive, negative, or neutral

Allowed: positive, negative, neutral | | humanFeedbackComment | string | Comment accompanying the human feedback | | humanFeedbackType | string | Type of human feedback: multilanguage, documentation, reasoning, images, charting, api, code, math, or moderation

Allowed: multilanguage, documentation, reasoning, images, charting, api, code, math, moderation | | humanFeedbackSubType | string | Sub-type of human feedback (varies by parent type) | | humanFeedbackProvidedBy | string | User who provided the human feedback | | adminResolution | string | Admin resolution notes for the feedback | | adminChecked | boolean | Whether an admin has reviewed this message | | autoTune | boolean | Whether auto-tuning from feedback is enabled | | scoring | integer | JSON-encoded quality scoring for the message | | metadata | object | Arbitrary metadata key-value pairs (JSON) | | createdBy | string | User ID who created the stream | | updatedBy | string | User ID who last updated the stream | | createdAt | string | Timestamp when this resource was created | | updatedAt | string | Timestamp when this resource was last updated |

Example

const result = await client.streams.get('agent-id');

list

async list(limit?: number)

Endpoint: GET /stream/list · API service

Example

const result = await client.streams.list();