docs:runs.title
docs:runs.desc
docs:runs.record.title
POST /api/sdk/run
docs:runs.record.requestBody
{
"promptId": 1,
"provider": "openai",
"userInput": "Tell me a joke",
"response": "Why did the chicken cross the road?",
"variables": {
"model": "gpt-4",
"temperature": 0.7
},
"tokenUsage": {
"promptTokens": 50,
"completionTokens": 30,
"totalTokens": 80
}
}docs:runs.record.response
{
"id": 123
}docs:runs.list.title
NEWdocs:runs.list.desc
GET /api/sdk/runs
docs:runs.list.queryParams
| docs:runs.list.param | docs:runs.list.type | docs:runs.list.description |
|---|---|---|
| promptId | number | docs:runs.params.promptId |
| limit | number | docs:runs.params.limit |
| offset | number | docs:runs.params.offset |
docs:runs.list.response
[
{
"id": 123,
"promptId": 1,
"provider": "openai",
"response": "Why did the chicken cross the road?",
"variables": { "model": "gpt-4" },
"userInput": "Tell me a joke",
"createdAt": "2024-12-05T10:00:00Z"
}
]docs:runs.sdk.title
TypeScript
// Record run
const { id } = await client.recordRun({
promptId: 1,
response: 'AI response content',
provider: 'openai',
tokenUsage: { totalTokens: 80 }
});
// Get runs
const runs = await client.getRuns({
promptId: 1,
limit: 20
});
// Batch record
const result = await client.batchRecordRuns([
{ promptId: 1, response: 'Response 1' },
{ promptId: 2, response: 'Response 2' }
]);
console.log(`Success: ${result.successful}, Failed: ${result.failed}`);