Skip to main content

Request Logs

Request Logs

@toothfairyai/sdk@latest…

Accessed via client.requestLogs.

Methods

MethodHTTPEndpoint
getGETGET /request/get/{id}
listGETGET /request/list

get

async get(id: string)

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

Response fields

FieldTypeDescription
idstringUnique identifier for the request log
srtKeystringSort key for the request
typestringType 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 | | words | integer | Number of words processed | | tokens | integer | Number of tokens processed | | sentences | integer | Number of sentences processed | | artifactsNumber | integer | Number of artifacts generated | | modelType | string | Model used for the request

Allowed: extraSmall, small, medium, large, extraLarge, local, custom, external | | outputType | string | Type of output generated: images, videos, modelling, text, code_interpreter, canvas, internet_search, deep_thinking, browser, audio, voice, or rag

Allowed: images, videos, modelling, text, code_interpreter, canvas, internet_search, deep_thinking, browser, audio, voice, rag | | inputTokens | integer | Number of input tokens consumed | | outputTokens | integer | Number of output tokens generated | | totalTokens | integer | Total tokens (input + output) | | inputCostUSD | number | Cost of input tokens in USD | | outputCostUSD | number | Cost of output tokens in USD | | totalCostUSD | number | Total cost in USD | | callType | string | Type of API call | | callPurpose | string | Purpose of the API call | | latencyMs | integer | Request latency in milliseconds | | agentID | string | ID of the agent associated with this resource | | workspaceID | string | Unique workspace identifier (UUID v4) | | createdBy | string | User ID who created the request | | updatedBy | string | User ID who last updated the request | | creationTime | integer | Unix timestamp when the resource was created | | isFromToothFairy | boolean | Whether the request originated from ToothFairyAI's own services | | chatID | string | ID of the chat this message belongs to | | messageID | string | ID of the associated chat message | | createdAt | string | Timestamp when this resource was created | | updatedAt | string | Timestamp when this resource was last updated |

Example

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

list

async list(limit?: number)

Endpoint: GET /request/list · API service

Example

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