{ "openapi": "3.1.0", "info": { "title": "tx-agent-kit Agent API", "version": "0.1.0", "summary": "Public API surface for tx-agent-kit CLI, MCP, and SDK clients.", "description": "The tx-agent-kit Agent API is the public surface behind the tx-agent-kit CLI, MCP server, and generated SDKs: manage organizations, teams, and the media library, drive the Trace Learn learning surface, and read billing, all scoped to your organizations and teams.\n\n**Authentication.** Every request needs a bearer token (`Authorization: Bearer `). Agent clients obtain one via `tx-agent-kit login` (device authorization) or an organization API key; see the Authentication page.\n\n**Pagination.** List endpoints return `{ data, total, nextCursor, prevCursor }`. `nextCursor`/`prevCursor` are opaque and null at the ends of the list; pass `nextCursor` back as the `cursor` query parameter to fetch the next page. `limit` caps page size (default 25, max 100).\n\n**Costs.** Paid operations reserve organization credits up front and finalize after completion; check the credit balance endpoint before costed calls. Mutating and paid operations are confirmation-gated in the CLI/MCP clients, which preview costs before executing." }, "paths": { "/v1/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listOrganizations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.listOrganizations({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.list_organizations()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations list-organizations" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/organizations\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List organizations", "x-displayName": "List organizations" }, "post": { "tags": [ "Organizations" ], "operationId": "organizations.createOrganization", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.createOrganization({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.create_organization(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations create-organization \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/organizations\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create organization", "x-displayName": "Create organization" } }, "/v1/invitations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listInvitations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filter[role]", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "token", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-INV-002" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.listInvitations({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.list_invitations()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations list-invitations" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/invitations\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List invitations", "x-displayName": "List invitations" }, "post": { "tags": [ "Organizations" ], "operationId": "organizations.createInvitation", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "token", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "email", "role" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member" ] }, "teamId": { "$ref": "#/components/schemas/UUID" }, "membershipType": { "type": "string", "enum": [ "team", "client" ] } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.createInvitation({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.create_invitation(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations create-invitation \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/invitations\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create invitation", "x-displayName": "Create invitation" } }, "/v1/invitations/{invitationId}": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.getInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "token", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-INV-002" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.getInvitation({\n invitationId: process.env.TX_AGENT_KIT_INVITATION_ID ?? \"invitationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.get_invitation(\n invitationId=os.environ.get(\"TX_AGENT_KIT_INVITATION_ID\", \"invitationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations get-invitation \\\n --request '{\"path\":{\"invitationId\":\"invitationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let invitation_id = env::var(\"TX_AGENT_KIT_INVITATION_ID\").unwrap_or_else(|_| \"invitationId\".to_string());\n let url = format!(\"{}/v1/invitations/{}\", base_url.trim_end_matches('/'), invitation_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final invitationId = Platform.environment['TX_AGENT_KIT_INVITATION_ID'] ?? 'invitationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations/$invitationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Invitation", "x-displayName": "Invitation" }, "patch": { "tags": [ "Organizations" ], "operationId": "organizations.updateInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "role": { "type": "string", "enum": [ "admin", "member" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.updateInvitation({\n invitationId: process.env.TX_AGENT_KIT_INVITATION_ID ?? \"invitationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.update_invitation(\n invitationId=os.environ.get(\"TX_AGENT_KIT_INVITATION_ID\", \"invitationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations update-invitation \\\n --request '{\"path\":{\"invitationId\":\"invitationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let invitation_id = env::var(\"TX_AGENT_KIT_INVITATION_ID\").unwrap_or_else(|_| \"invitationId\".to_string());\n let url = format!(\"{}/v1/invitations/{}\", base_url.trim_end_matches('/'), invitation_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final invitationId = Platform.environment['TX_AGENT_KIT_INVITATION_ID'] ?? 'invitationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations/$invitationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update invitation", "x-displayName": "Update invitation" }, "delete": { "tags": [ "Organizations" ], "operationId": "organizations.removeInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.removeInvitation({\n invitationId: process.env.TX_AGENT_KIT_INVITATION_ID ?? \"invitationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.remove_invitation(\n invitationId=os.environ.get(\"TX_AGENT_KIT_INVITATION_ID\", \"invitationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations remove-invitation \\\n --request '{\"path\":{\"invitationId\":\"invitationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let invitation_id = env::var(\"TX_AGENT_KIT_INVITATION_ID\").unwrap_or_else(|_| \"invitationId\".to_string());\n let url = format!(\"{}/v1/invitations/{}\", base_url.trim_end_matches('/'), invitation_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final invitationId = Platform.environment['TX_AGENT_KIT_INVITATION_ID'] ?? 'invitationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations/$invitationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete invitation", "x-displayName": "Delete invitation" } }, "/v1/invitations/{token}/accept": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.acceptInvitation", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted" ], "properties": { "accepted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-INV-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.acceptInvitation({\n token: process.env.TX_AGENT_KIT_TOKEN ?? \"token\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.accept_invitation(\n token=os.environ.get(\"TX_AGENT_KIT_TOKEN\", \"token\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations accept-invitation \\\n --request '{\"path\":{\"token\":\"token\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").unwrap_or_else(|_| \"token\".to_string());\n let url = format!(\"{}/v1/invitations/{}/accept\", base_url.trim_end_matches('/'), token);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'] ?? 'token';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations/$token/accept';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Accept invitation", "x-displayName": "Accept invitation" } }, "/v1/invitations/batch/get-many": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.getManyInvitations", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-INV-002" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.getManyInvitations({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.get_many_invitations(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations get-many-invitations \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/invitations/batch/get-many\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/invitations/batch/get-many';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Get many invitations", "x-displayName": "Get many invitations" } }, "/v1/organizations/{organizationId}": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.getOrganization", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.getOrganization({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.get_organization(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations get-organization \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Organization", "x-displayName": "Organization" }, "patch": { "tags": [ "Organizations" ], "operationId": "organizations.updateOrganization", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.updateOrganization({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.update_organization(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations update-organization \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update organization", "x-displayName": "Update organization" }, "delete": { "tags": [ "Organizations" ], "operationId": "organizations.removeOrganization", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.removeOrganization({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.remove_organization(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations remove-organization \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete organization", "x-displayName": "Delete organization" } }, "/v1/organizations/{organizationId}/invitations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listOrgInvitations", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[status]", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filter[role]", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "email", "role", "status", "invitedByUserId", "expiresAt", "revokedAt", "revokedByUserId", "teamId", "membershipType", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "invitedByUserId": { "$ref": "#/components/schemas/UUID" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedByUserId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.listOrgInvitations({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.list_org_invitations(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations list-org-invitations \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/invitations\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/invitations';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List org invitations", "x-displayName": "List org invitations" } }, "/v1/organizations/{organizationId}/members": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listOrgMembers", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "userId", "role", "membershipType", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.listOrgMembers({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.list_org_members(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations list-org-members \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List org members", "x-displayName": "List org members" }, "post": { "tags": [ "Organizations" ], "operationId": "organizations.addOrgMember", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "userId", "role", "membershipType", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member" ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.addOrgMember({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.add_org_member(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations add-org-member \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Add org member", "x-displayName": "Add org member" } }, "/v1/organizations/{organizationId}/members/{memberId}": { "delete": { "tags": [ "Organizations" ], "operationId": "organizations.removeMember", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.removeMember({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.remove_member(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations remove-member \\\n --request '{\"path\":{\"organizationId\":\"organizationId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members/{}\", base_url.trim_end_matches('/'), organization_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members/$memberId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete member", "x-displayName": "Delete member" } }, "/v1/organizations/{organizationId}/members/{memberId}/disable": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.disableMember", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "userId", "role", "membershipType", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.disableMember({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.disable_member(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations disable-member \\\n --request '{\"path\":{\"organizationId\":\"organizationId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members/{}/disable\", base_url.trim_end_matches('/'), organization_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members/$memberId/disable';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Disable member", "x-displayName": "Disable member" } }, "/v1/organizations/{organizationId}/members/{memberId}/enable": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.enableMember", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "userId", "role", "membershipType", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.enableMember({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.enable_member(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations enable-member \\\n --request '{\"path\":{\"organizationId\":\"organizationId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members/{}/enable\", base_url.trim_end_matches('/'), organization_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members/$memberId/enable';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Enable member", "x-displayName": "Enable member" } }, "/v1/organizations/{organizationId}/members/{memberId}/role": { "patch": { "tags": [ "Organizations" ], "operationId": "organizations.updateMemberRole", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "userId", "role", "membershipType", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "membershipType": { "type": "string", "enum": [ "team", "client" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "enum": [ "admin", "member" ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.updateMemberRole({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.update_member_role(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations update-member-role \\\n --request '{\"path\":{\"organizationId\":\"organizationId\",\"memberId\":\"memberId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/members/{}/role\", base_url.trim_end_matches('/'), organization_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/members/$memberId/role';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update member role", "x-displayName": "Update member role" } }, "/v1/organizations/{organizationId}/transfer-ownership": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.transferOwnership", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "transferred" ], "properties": { "transferred": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "newOwnerUserId" ], "properties": { "newOwnerUserId": { "$ref": "#/components/schemas/UUID" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.transferOwnership({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.transfer_ownership(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations transfer-ownership \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/transfer-ownership\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/transfer-ownership';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Transfer ownership", "x-displayName": "Transfer ownership" } }, "/v1/organizations/batch/get-many": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.getManyOrganizations", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "workspace_setup", "goals", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "agent_execution", "automation", "analytics", "internal_tools", "other" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.organizations.getManyOrganizations({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.organizations.get_many_organizations(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit organizations get-many-organizations \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/organizations/batch/get-many\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/batch/get-many';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Get many organizations", "x-displayName": "Get many organizations" } }, "/v1/teams": { "get": { "tags": [ "Teams" ], "operationId": "teams.listTeams", "parameters": [ { "name": "organizationId", "in": "query", "schema": { "$ref": "#/components/schemas/UUID" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "name", "website", "brandSettings", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.listTeams({\n query: {\n \"organizationId\": process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.list_teams(\n query={\n \"organizationId\": os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams list-teams \\\n --request '{\"query\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/teams\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let query = [(\"organizationId\", organization_id.as_str())];\n request = request.query(&query);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams';\n final uri = Uri.parse(url).replace(queryParameters: {\n 'organizationId': organizationId,\n });\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List teams", "x-displayName": "List teams" }, "post": { "tags": [ "Teams" ], "operationId": "teams.createTeam", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "name", "website", "brandSettings", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "name", "brandSettings" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.createTeam({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.create_team(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams create-team \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/teams\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create team", "x-displayName": "Create team" } }, "/v1/review/{token}": { "get": { "tags": [ "Teams" ], "operationId": "teams.validateReviewToken", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "valid" ], "properties": { "valid": { "type": "boolean" }, "token": { "type": "object", "required": [ "id", "teamId", "token", "expiresAt", "revokedAt", "permissions", "reviewerName", "reviewerEmail", "lastAccessedAt", "createdBy", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view", "comment", "approve", "reject" ] } }, "reviewerName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastAccessedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "$ref": "#/components/schemas/UUID" }, "createdAt": { "type": "string" } }, "additionalProperties": false }, "teamId": { "$ref": "#/components/schemas/UUID" }, "permissions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.validateReviewToken({\n token: process.env.TX_AGENT_KIT_TOKEN ?? \"token\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.validate_review_token(\n token=os.environ.get(\"TX_AGENT_KIT_TOKEN\", \"token\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams validate-review-token \\\n --request '{\"path\":{\"token\":\"token\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").unwrap_or_else(|_| \"token\".to_string());\n let url = format!(\"{}/v1/review/{}\", base_url.trim_end_matches('/'), token);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'] ?? 'token';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/review/$token';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Validate review token", "x-displayName": "Validate review token" } }, "/v1/teams/{teamId}": { "get": { "tags": [ "Teams" ], "operationId": "teams.getTeam", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "name", "website", "brandSettings", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.getTeam({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.get_team(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams get-team \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Team", "x-displayName": "Team" }, "patch": { "tags": [ "Teams" ], "operationId": "teams.updateTeam", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "organizationId", "name", "website", "brandSettings", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.updateTeam({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.update_team(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams update-team \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update team", "x-displayName": "Update team" }, "delete": { "tags": [ "Teams" ], "operationId": "teams.removeTeam", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.removeTeam({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.remove_team(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams remove-team \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete team", "x-displayName": "Delete team" } }, "/v1/teams/{teamId}/members": { "get": { "tags": [ "Teams" ], "operationId": "teams.listTeamMembers", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "userId", "roleId", "role", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.listTeamMembers({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.list_team_members(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams list-team-members \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List team members", "x-displayName": "List team members" }, "post": { "tags": [ "Teams" ], "operationId": "teams.addTeamMember", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "userId", "roleId", "role", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "$ref": "#/components/schemas/UUID" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.addTeamMember({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.add_team_member(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams add-team-member \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Add team member", "x-displayName": "Add team member" } }, "/v1/teams/{teamId}/members/{memberId}": { "delete": { "tags": [ "Teams" ], "operationId": "teams.removeTeamMember", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.removeTeamMember({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.remove_team_member(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams remove-team-member \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members/{}\", base_url.trim_end_matches('/'), team_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members/$memberId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete team member", "x-displayName": "Delete team member" } }, "/v1/teams/{teamId}/members/{memberId}/disable": { "post": { "tags": [ "Teams" ], "operationId": "teams.disableTeamMember", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "userId", "roleId", "role", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.disableTeamMember({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.disable_team_member(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams disable-team-member \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members/{}/disable\", base_url.trim_end_matches('/'), team_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members/$memberId/disable';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Disable team member", "x-displayName": "Disable team member" } }, "/v1/teams/{teamId}/members/{memberId}/enable": { "post": { "tags": [ "Teams" ], "operationId": "teams.enableTeamMember", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "userId", "roleId", "role", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.enableTeamMember({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.enable_team_member(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams enable-team-member \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"memberId\":\"memberId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members/{}/enable\", base_url.trim_end_matches('/'), team_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members/$memberId/enable';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Enable team member", "x-displayName": "Enable team member" } }, "/v1/teams/{teamId}/members/{memberId}/role": { "patch": { "tags": [ "Teams" ], "operationId": "teams.updateTeamMemberRole", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "memberId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "userId", "roleId", "role", "disabledAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "userId": { "$ref": "#/components/schemas/UUID" }, "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "disabledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "roleId" ], "properties": { "roleId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.updateTeamMemberRole({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n memberId: process.env.TX_AGENT_KIT_MEMBER_ID ?? \"memberId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.update_team_member_role(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n memberId=os.environ.get(\"TX_AGENT_KIT_MEMBER_ID\", \"memberId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams update-team-member-role \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"memberId\":\"memberId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let member_id = env::var(\"TX_AGENT_KIT_MEMBER_ID\").unwrap_or_else(|_| \"memberId\".to_string());\n let url = format!(\"{}/v1/teams/{}/members/{}/role\", base_url.trim_end_matches('/'), team_id, member_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final memberId = Platform.environment['TX_AGENT_KIT_MEMBER_ID'] ?? 'memberId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/members/$memberId/role';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update team member role", "x-displayName": "Update team member role" } }, "/v1/teams/{teamId}/review-tokens": { "get": { "tags": [ "Teams" ], "operationId": "teams.listReviewTokens", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "token", "expiresAt", "revokedAt", "permissions", "reviewerName", "reviewerEmail", "lastAccessedAt", "createdBy", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view", "comment", "approve", "reject" ] } }, "reviewerName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastAccessedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "$ref": "#/components/schemas/UUID" }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.listReviewTokens({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.list_review_tokens(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams list-review-tokens \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/review-tokens\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/review-tokens';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List review tokens", "x-displayName": "List review tokens" }, "post": { "tags": [ "Teams" ], "operationId": "teams.createReviewToken", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "token", "expiresAt", "revokedAt", "permissions", "reviewerName", "reviewerEmail", "lastAccessedAt", "createdBy", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view", "comment", "approve", "reject" ] } }, "reviewerName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastAccessedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "$ref": "#/components/schemas/UUID" }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "permissions" ], "properties": { "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view", "comment", "approve", "reject" ] } }, "reviewerName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresInDays": { "type": "number" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.createReviewToken({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.create_review_token(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams create-review-token \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/review-tokens\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/review-tokens';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create review token", "x-displayName": "Create review token" } }, "/v1/teams/{teamId}/review-tokens/{tokenId}": { "delete": { "tags": [ "Teams" ], "operationId": "teams.revokeReviewToken", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "tokenId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.teams.revokeReviewToken({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n tokenId: process.env.TX_AGENT_KIT_TOKEN_ID ?? \"tokenId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.teams.revoke_review_token(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n tokenId=os.environ.get(\"TX_AGENT_KIT_TOKEN_ID\", \"tokenId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit teams revoke-review-token \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"tokenId\":\"tokenId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let token_id = env::var(\"TX_AGENT_KIT_TOKEN_ID\").unwrap_or_else(|_| \"tokenId\".to_string());\n let url = format!(\"{}/v1/teams/{}/review-tokens/{}\", base_url.trim_end_matches('/'), team_id, token_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final tokenId = Platform.environment['TX_AGENT_KIT_TOKEN_ID'] ?? 'tokenId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/review-tokens/$tokenId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Revoke review token", "x-displayName": "Revoke review token" } }, "/v1/teams/{teamId}/assets": { "get": { "tags": [ "Assets" ], "operationId": "assets.listAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[assetType]", "in": "query", "schema": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.listAssets({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.list_assets(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets list-assets \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List assets", "x-displayName": "List assets" } }, "/v1/teams/{teamId}/assets/{assetId}": { "get": { "tags": [ "Assets" ], "operationId": "assets.getAsset", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.getAsset({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.get_asset(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets get-asset \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/{}\", base_url.trim_end_matches('/'), team_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/$assetId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Asset", "x-displayName": "Asset" }, "patch": { "tags": [ "Assets" ], "operationId": "assets.updateAssetMetadata", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "sharedWithOrg": { "type": "boolean" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.updateAssetMetadata({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.update_asset_metadata(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets update-asset-metadata \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/{}\", base_url.trim_end_matches('/'), team_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/$assetId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update asset metadata", "x-displayName": "Update asset metadata" }, "delete": { "tags": [ "Assets" ], "operationId": "assets.softDeleteAsset", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.softDeleteAsset({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.soft_delete_asset(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets soft-delete-asset \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/{}\", base_url.trim_end_matches('/'), team_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/$assetId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Soft delete asset", "x-displayName": "Soft delete asset" } }, "/v1/teams/{teamId}/assets/{assetId}/thumbnail-url": { "get": { "tags": [ "Assets" ], "operationId": "assets.getAssetThumbnailSignedUrl", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.getAssetThumbnailSignedUrl({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.get_asset_thumbnail_signed_url(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets get-asset-thumbnail-signed-url \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/{}/thumbnail-url\", base_url.trim_end_matches('/'), team_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/$assetId/thumbnail-url';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Asset thumbnail signed URL", "x-displayName": "Asset thumbnail signed URL" } }, "/v1/teams/{teamId}/assets/{assetId}/url": { "get": { "tags": [ "Assets" ], "operationId": "assets.getAssetSignedUrl", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.getAssetSignedUrl({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.get_asset_signed_url(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets get-asset-signed-url \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/{}/url\", base_url.trim_end_matches('/'), team_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/$assetId/url';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Asset signed URL", "x-displayName": "Asset signed URL" } }, "/v1/teams/{teamId}/assets/search": { "get": { "tags": [ "Assets" ], "operationId": "assets.searchAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "query", "in": "query", "schema": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "required": true, "description": "a string at least 1 character(s) long" }, { "name": "semantic", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[assetType]", "in": "query", "schema": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.searchAssets({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n query: {\n \"query\": process.env.TX_AGENT_KIT_QUERY ?? \"query\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.search_assets(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n query={\n \"query\": os.environ.get(\"TX_AGENT_KIT_QUERY\", \"query\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets search-assets \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"query\":{\"query\":\"query\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let query = env::var(\"TX_AGENT_KIT_QUERY\").unwrap_or_else(|_| \"query\".to_string());\n let url = format!(\"{}/v1/teams/{}/assets/search\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let query = [(\"query\", query.as_str())];\n request = request.query(&query);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final query = Platform.environment['TX_AGENT_KIT_QUERY'] ?? 'query';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/assets/search';\n final uri = Uri.parse(url).replace(queryParameters: {\n 'query': query,\n });\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Search assets", "x-displayName": "Search assets" } }, "/v1/teams/{teamId}/collections": { "get": { "tags": [ "Assets" ], "operationId": "assets.listCollections", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "name", "description", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.listCollections({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.list_collections(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets list-collections \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List collections", "x-displayName": "List collections" }, "post": { "tags": [ "Assets" ], "operationId": "assets.createCollection", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "name", "description", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.createCollection({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.create_collection(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets create-collection \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create collection", "x-displayName": "Create collection" } }, "/v1/teams/{teamId}/collections/{collectionId}": { "patch": { "tags": [ "Assets" ], "operationId": "assets.updateCollection", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "collectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "name", "description", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.updateCollection({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n collectionId: process.env.TX_AGENT_KIT_COLLECTION_ID ?? \"collectionId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.update_collection(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n collectionId=os.environ.get(\"TX_AGENT_KIT_COLLECTION_ID\", \"collectionId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets update-collection \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"collectionId\":\"collectionId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let collection_id = env::var(\"TX_AGENT_KIT_COLLECTION_ID\").unwrap_or_else(|_| \"collectionId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections/{}\", base_url.trim_end_matches('/'), team_id, collection_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final collectionId = Platform.environment['TX_AGENT_KIT_COLLECTION_ID'] ?? 'collectionId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections/$collectionId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update collection", "x-displayName": "Update collection" }, "delete": { "tags": [ "Assets" ], "operationId": "assets.removeCollection", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "collectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.removeCollection({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n collectionId: process.env.TX_AGENT_KIT_COLLECTION_ID ?? \"collectionId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.remove_collection(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n collectionId=os.environ.get(\"TX_AGENT_KIT_COLLECTION_ID\", \"collectionId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets remove-collection \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"collectionId\":\"collectionId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let collection_id = env::var(\"TX_AGENT_KIT_COLLECTION_ID\").unwrap_or_else(|_| \"collectionId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections/{}\", base_url.trim_end_matches('/'), team_id, collection_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final collectionId = Platform.environment['TX_AGENT_KIT_COLLECTION_ID'] ?? 'collectionId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections/$collectionId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete collection", "x-displayName": "Delete collection" } }, "/v1/teams/{teamId}/collections/{collectionId}/assets": { "get": { "tags": [ "Assets" ], "operationId": "assets.listCollectionAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "collectionId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[assetType]", "in": "query", "schema": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.listCollectionAssets({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n collectionId: process.env.TX_AGENT_KIT_COLLECTION_ID ?? \"collectionId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.list_collection_assets(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n collectionId=os.environ.get(\"TX_AGENT_KIT_COLLECTION_ID\", \"collectionId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets list-collection-assets \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"collectionId\":\"collectionId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let collection_id = env::var(\"TX_AGENT_KIT_COLLECTION_ID\").unwrap_or_else(|_| \"collectionId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections/{}/assets\", base_url.trim_end_matches('/'), team_id, collection_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final collectionId = Platform.environment['TX_AGENT_KIT_COLLECTION_ID'] ?? 'collectionId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections/$collectionId/assets';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List collection assets", "x-displayName": "List collection assets" }, "post": { "tags": [ "Assets" ], "operationId": "assets.addAssetToCollection", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "collectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.addAssetToCollection({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n collectionId: process.env.TX_AGENT_KIT_COLLECTION_ID ?? \"collectionId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.add_asset_to_collection(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n collectionId=os.environ.get(\"TX_AGENT_KIT_COLLECTION_ID\", \"collectionId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets add-asset-to-collection \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"collectionId\":\"collectionId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let collection_id = env::var(\"TX_AGENT_KIT_COLLECTION_ID\").unwrap_or_else(|_| \"collectionId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections/{}/assets\", base_url.trim_end_matches('/'), team_id, collection_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final collectionId = Platform.environment['TX_AGENT_KIT_COLLECTION_ID'] ?? 'collectionId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections/$collectionId/assets';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Add asset to collection", "x-displayName": "Add asset to collection" } }, "/v1/teams/{teamId}/collections/{collectionId}/assets/{assetId}": { "delete": { "tags": [ "Assets" ], "operationId": "assets.removeAssetFromCollection", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "collectionId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.removeAssetFromCollection({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n collectionId: process.env.TX_AGENT_KIT_COLLECTION_ID ?? \"collectionId\",\n assetId: process.env.TX_AGENT_KIT_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.remove_asset_from_collection(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n collectionId=os.environ.get(\"TX_AGENT_KIT_COLLECTION_ID\", \"collectionId\"),\n assetId=os.environ.get(\"TX_AGENT_KIT_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets remove-asset-from-collection \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"collectionId\":\"collectionId\",\"assetId\":\"assetId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let collection_id = env::var(\"TX_AGENT_KIT_COLLECTION_ID\").unwrap_or_else(|_| \"collectionId\".to_string());\n let asset_id = env::var(\"TX_AGENT_KIT_ASSET_ID\").unwrap_or_else(|_| \"assetId\".to_string());\n let url = format!(\"{}/v1/teams/{}/collections/{}/assets/{}\", base_url.trim_end_matches('/'), team_id, collection_id, asset_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final collectionId = Platform.environment['TX_AGENT_KIT_COLLECTION_ID'] ?? 'collectionId';\n final assetId = Platform.environment['TX_AGENT_KIT_ASSET_ID'] ?? 'assetId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/collections/$collectionId/assets/$assetId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete asset from collection", "x-displayName": "Delete asset from collection" } }, "/v1/teams/{teamId}/uploads/{uploadId}/confirm": { "post": { "tags": [ "Assets" ], "operationId": "assets.confirmUpload", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "uploadId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "$id": "/schemas/unknown", "title": "unknown" }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.confirmUpload({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n uploadId: process.env.TX_AGENT_KIT_UPLOAD_ID ?? \"uploadId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.confirm_upload(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n uploadId=os.environ.get(\"TX_AGENT_KIT_UPLOAD_ID\", \"uploadId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets confirm-upload \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"uploadId\":\"uploadId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let upload_id = env::var(\"TX_AGENT_KIT_UPLOAD_ID\").unwrap_or_else(|_| \"uploadId\".to_string());\n let url = format!(\"{}/v1/teams/{}/uploads/{}/confirm\", base_url.trim_end_matches('/'), team_id, upload_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final uploadId = Platform.environment['TX_AGENT_KIT_UPLOAD_ID'] ?? 'uploadId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/uploads/$uploadId/confirm';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Confirm upload", "x-displayName": "Confirm upload" } }, "/v1/teams/{teamId}/uploads/{uploadId}/content": { "put": { "tags": [ "Assets" ], "operationId": "assets.uploadContent", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "uploadId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "uploaded" ], "properties": { "uploaded": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.uploadContent({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n uploadId: process.env.TX_AGENT_KIT_UPLOAD_ID ?? \"uploadId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.upload_content(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n uploadId=os.environ.get(\"TX_AGENT_KIT_UPLOAD_ID\", \"uploadId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets upload-content \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"uploadId\":\"uploadId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let upload_id = env::var(\"TX_AGENT_KIT_UPLOAD_ID\").unwrap_or_else(|_| \"uploadId\".to_string());\n let url = format!(\"{}/v1/teams/{}/uploads/{}/content\", base_url.trim_end_matches('/'), team_id, upload_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.put(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final uploadId = Platform.environment['TX_AGENT_KIT_UPLOAD_ID'] ?? 'uploadId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/uploads/$uploadId/content';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.put(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Upload content", "x-displayName": "Upload content" } }, "/v1/teams/{teamId}/uploads/request": { "post": { "tags": [ "Assets" ], "operationId": "assets.requestUpload", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "uploadId", "presignedUrl", "deduplicated", "existingAssetId" ], "properties": { "uploadId": { "$ref": "#/components/schemas/UUID" }, "presignedUrl": { "type": "string" }, "deduplicated": { "type": "boolean" }, "existingAssetId": { "anyOf": [ { "$ref": "#/components/schemas/UUID" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fileName", "fileSize", "contentHash", "mimeType" ], "properties": { "fileName": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "fileSize": { "type": "integer", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mimeType": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.assets.requestUpload({\n teamId: process.env.TX_AGENT_KIT_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.assets.request_upload(\n teamId=os.environ.get(\"TX_AGENT_KIT_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit assets request-upload \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let team_id = env::var(\"TX_AGENT_KIT_TEAM_ID\").unwrap_or_else(|_| \"teamId\".to_string());\n let url = format!(\"{}/v1/teams/{}/uploads/request\", base_url.trim_end_matches('/'), team_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final teamId = Platform.environment['TX_AGENT_KIT_TEAM_ID'] ?? 'teamId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId/uploads/request';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Request upload", "x-displayName": "Request upload" } }, "/v1/billing/{organizationId}/auto-recharge/requires-action": { "get": { "tags": [ "Billing" ], "operationId": "billing.getAutoRechargeRequiresAction", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "attemptId", "amountDecimillicents", "stripePaymentIntentId", "clientSecret" ], "properties": { "attemptId": { "$ref": "#/components/schemas/UUID" }, "amountDecimillicents": { "type": "number" }, "stripePaymentIntentId": { "type": "string" }, "clientSecret": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getAutoRechargeRequiresAction({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_auto_recharge_requires_action(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-auto-recharge-requires-action \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/auto-recharge/requires-action\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/auto-recharge/requires-action';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Auto recharge requires action", "x-displayName": "Auto recharge requires action" } }, "/v1/billing/{organizationId}/credits": { "get": { "tags": [ "Billing" ], "operationId": "billing.getCreditBalance", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "creditsBalanceDecimillicents", "reservedCreditsDecimillicents", "availableDecimillicents", "isSuspended", "suspendedAt", "paymentGracePeriodEndsAt" ], "properties": { "creditsBalanceDecimillicents": { "type": "number" }, "reservedCreditsDecimillicents": { "type": "number" }, "availableDecimillicents": { "type": "number" }, "isSuspended": { "type": "boolean" }, "suspendedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentGracePeriodEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getCreditBalance({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_credit_balance(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-credit-balance \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/credits\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/credits';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Credit balance", "x-displayName": "Credit balance" } }, "/v1/billing/{organizationId}/credits/history": { "get": { "tags": [ "Billing" ], "operationId": "billing.getCreditHistory", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "cursor", "hasMore" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "entryType", "amountDecimillicents", "reason", "referenceId", "balanceAfter", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "entryType": { "type": "string", "enum": [ "purchase", "usage", "adjustment", "refund", "auto_recharge", "reserve", "release" ] }, "amountDecimillicents": { "type": "number" }, "reason": { "type": "string" }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balanceAfter": { "type": "number" }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hasMore": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getCreditHistory({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_credit_history(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-credit-history \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/credits/history\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/credits/history';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Credit history", "x-displayName": "Credit history" } }, "/v1/billing/{organizationId}/no-cap-reminder": { "get": { "tags": [ "Billing" ], "operationId": "billing.getNoCapReminder", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "dismissed" ], "properties": { "dismissed": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getNoCapReminder({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_no_cap_reminder(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-no-cap-reminder \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/no-cap-reminder\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/no-cap-reminder';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "No cap reminder", "x-displayName": "No cap reminder" } }, "/v1/billing/{organizationId}/no-cap-reminder/dismiss": { "post": { "tags": [ "Billing" ], "operationId": "billing.dismissNoCapReminder", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "dismissed" ], "properties": { "dismissed": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.dismissNoCapReminder({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.dismiss_no_cap_reminder(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing dismiss-no-cap-reminder \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/no-cap-reminder/dismiss\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/no-cap-reminder/dismiss';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Dismiss no cap reminder", "x-displayName": "Dismiss no cap reminder" } }, "/v1/billing/{organizationId}/top-up": { "post": { "tags": [ "Billing" ], "operationId": "billing.createTopUpSession", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amountDecimillicents", "successUrl", "cancelUrl" ], "properties": { "amountDecimillicents": { "type": "integer", "description": "a number less than or equal to 5000000000", "title": "lessThanOrEqualTo(5000000000)", "minimum": 100000, "maximum": 5000000000 }, "successUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" }, "cancelUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.createTopUpSession({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.create_top_up_session(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing create-top-up-session \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/billing/{}/top-up\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/top-up';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create top up session", "x-displayName": "Create top up session" } }, "/v1/billing/checkout": { "post": { "tags": [ "Billing" ], "operationId": "billing.createCheckoutSession", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "subscriptionPlan", "successUrl", "cancelUrl" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "subscriptionPlan": { "type": "string", "enum": [ "try_me", "pro", "agency" ] }, "successUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" }, "cancelUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.createCheckoutSession({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.create_checkout_session(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing create-checkout-session \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/billing/checkout\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/checkout';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create checkout session", "x-displayName": "Create checkout session" } }, "/v1/billing/portal": { "post": { "tags": [ "Billing" ], "operationId": "billing.createPortalSession", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "returnUrl" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "returnUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.createPortalSession({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.create_portal_session(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing create-portal-session \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/billing/portal\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/portal';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create portal session", "x-displayName": "Create portal session" } }, "/v1/organizations/{organizationId}/billing": { "get": { "tags": [ "Billing" ], "operationId": "billing.getBillingSettings", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "billingEmail", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalanceDecimillicents", "reservedCreditsDecimillicents", "autoRechargeEnabled", "autoRechargeThresholdDecimillicents", "autoRechargeAmountDecimillicents", "usageCapDecimillicents", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "suspendedAt", "paymentGracePeriodEndsAt" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalanceDecimillicents": { "type": "number" }, "reservedCreditsDecimillicents": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThresholdDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmountDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "usageCapDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string", "enum": [ "try_me", "pro", "agency" ] }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspendedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentGracePeriodEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getBillingSettings({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_billing_settings(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-billing-settings \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/billing\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/billing';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Billing settings", "x-displayName": "Billing settings" }, "patch": { "tags": [ "Billing" ], "operationId": "billing.updateBillingSettings", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "billingEmail", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalanceDecimillicents", "reservedCreditsDecimillicents", "autoRechargeEnabled", "autoRechargeThresholdDecimillicents", "autoRechargeAmountDecimillicents", "usageCapDecimillicents", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "suspendedAt", "paymentGracePeriodEndsAt" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalanceDecimillicents": { "type": "number" }, "reservedCreditsDecimillicents": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThresholdDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmountDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "usageCapDecimillicents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string", "enum": [ "try_me", "pro", "agency" ] }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspendedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentGracePeriodEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThresholdDecimillicents": { "anyOf": [ { "type": "integer", "description": "a number less than or equal to 5000000000", "title": "lessThanOrEqualTo(5000000000)", "minimum": 1, "maximum": 5000000000 }, { "type": "null" } ] }, "autoRechargeAmountDecimillicents": { "anyOf": [ { "type": "integer", "description": "a number less than or equal to 5000000000", "title": "lessThanOrEqualTo(5000000000)", "minimum": 100000, "maximum": 5000000000 }, { "type": "null" } ] }, "usageCapDecimillicents": { "anyOf": [ { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.updateBillingSettings({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.update_billing_settings(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing update-billing-settings \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/billing\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/billing';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update billing settings", "x-displayName": "Update billing settings" } }, "/v1/organizations/{organizationId}/usage": { "get": { "tags": [ "Billing" ], "operationId": "billing.getUsageSummary", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "category", "in": "query", "schema": { "type": "string", "enum": [ "text_generation", "image_generation", "video_generation", "storage", "openrouter_inference", "workflow_execution", "api_call" ] }, "required": true }, { "name": "periodStart", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "periodEnd", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "category", "periodStart", "periodEnd", "totalQuantity", "totalCostDecimillicents" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "category": { "type": "string", "enum": [ "text_generation", "image_generation", "video_generation", "storage", "openrouter_inference", "workflow_execution", "api_call" ] }, "periodStart": { "type": "string" }, "periodEnd": { "type": "string" }, "totalQuantity": { "type": "number" }, "totalCostDecimillicents": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.billing.getUsageSummary({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n query: {\n \"category\": process.env.TX_AGENT_KIT_CATEGORY ?? \"category\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.billing.get_usage_summary(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\"),\n query={\n \"category\": os.environ.get(\"TX_AGENT_KIT_CATEGORY\", \"category\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit billing get-usage-summary \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"query\":{\"category\":\"category\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let category = env::var(\"TX_AGENT_KIT_CATEGORY\").unwrap_or_else(|_| \"category\".to_string());\n let url = format!(\"{}/v1/organizations/{}/usage\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let query = [(\"category\", category.as_str())];\n request = request.query(&query);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final category = Platform.environment['TX_AGENT_KIT_CATEGORY'] ?? 'category';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/usage';\n final uri = Uri.parse(url).replace(queryParameters: {\n 'category': category,\n });\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Usage summary", "x-displayName": "Usage summary" } }, "/v1/storage/delete": { "post": { "tags": [ "Storage" ], "operationId": "storage.deleteObject", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storage.deleteObject({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storage.delete_object(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storage delete-object \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/storage/delete\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/storage/delete';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Delete object", "x-displayName": "Delete object" } }, "/v1/storage/download-url": { "post": { "tags": [ "Storage" ], "operationId": "storage.generateDownloadUrl", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "expiresIn": { "type": "number" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storage.generateDownloadUrl({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storage.generate_download_url(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storage generate-download-url \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/storage/download-url\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/storage/download-url';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Generate download URL", "x-displayName": "Generate download URL" } }, "/v1/storage/objects": { "get": { "tags": [ "Storage" ], "operationId": "storage.listObjects", "parameters": [ { "name": "prefix", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "keys" ], "properties": { "keys": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storage.listObjects({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storage.list_objects()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storage list-objects" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/storage/objects\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/storage/objects';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List objects", "x-displayName": "List objects" } }, "/v1/storage/objects/{key}/metadata": { "get": { "tags": [ "Storage" ], "operationId": "storage.getObjectMetadata", "parameters": [ { "name": "key", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "contentType", "contentLength", "lastModified", "etag" ], "properties": { "key": { "type": "string" }, "contentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contentLength": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storage.getObjectMetadata({\n key: process.env.TX_AGENT_KIT_KEY ?? \"key\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storage.get_object_metadata(\n key=os.environ.get(\"TX_AGENT_KIT_KEY\", \"key\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storage get-object-metadata \\\n --request '{\"path\":{\"key\":\"key\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let key = env::var(\"TX_AGENT_KIT_KEY\").unwrap_or_else(|_| \"key\".to_string());\n let url = format!(\"{}/v1/storage/objects/{}/metadata\", base_url.trim_end_matches('/'), key);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final key = Platform.environment['TX_AGENT_KIT_KEY'] ?? 'key';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/storage/objects/$key/metadata';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Object metadata", "x-displayName": "Object metadata" } }, "/v1/storage/upload-url": { "post": { "tags": [ "Storage" ], "operationId": "storage.generateUploadUrl", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "contentType" ], "properties": { "key": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "contentType": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "expiresIn": { "type": "number" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storage.generateUploadUrl({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storage.generate_upload_url(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storage generate-upload-url \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/storage/upload-url\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/storage/upload-url';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Generate upload URL", "x-displayName": "Generate upload URL" } }, "/v1/organizations/{organizationId}/storage/quota": { "get": { "tags": [ "Storage metering" ], "operationId": "storagemetering.getStorageQuota", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "allowed", "currentBytes", "limitBytes" ], "properties": { "allowed": { "type": "boolean" }, "currentBytes": { "type": "number" }, "limitBytes": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storagemetering.getStorageQuota({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storagemetering.get_storage_quota(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storagemetering get-storage-quota \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/storage/quota\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/storage/quota';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Storage quota", "x-displayName": "Storage quota" } }, "/v1/organizations/{organizationId}/storage/usage": { "get": { "tags": [ "Storage metering" ], "operationId": "storagemetering.getStorageUsage", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "organizationId", "activeBytes", "softDeletedBytes", "activeAssetCount", "softDeletedAssetCount", "highWaterMarkBytes", "measuredAt" ], "properties": { "organizationId": { "$ref": "#/components/schemas/UUID" }, "activeBytes": { "type": "number" }, "softDeletedBytes": { "type": "number" }, "activeAssetCount": { "type": "number" }, "softDeletedAssetCount": { "type": "number" }, "highWaterMarkBytes": { "type": "number" }, "measuredAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.storagemetering.getStorageUsage({\n organizationId: process.env.TX_AGENT_KIT_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.storagemetering.get_storage_usage(\n organizationId=os.environ.get(\"TX_AGENT_KIT_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit storagemetering get-storage-usage \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let organization_id = env::var(\"TX_AGENT_KIT_ORGANIZATION_ID\").unwrap_or_else(|_| \"organizationId\".to_string());\n let url = format!(\"{}/v1/organizations/{}/storage/usage\", base_url.trim_end_matches('/'), organization_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final organizationId = Platform.environment['TX_AGENT_KIT_ORGANIZATION_ID'] ?? 'organizationId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/organizations/$organizationId/storage/usage';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Storage usage", "x-displayName": "Storage usage" } }, "/v1/roles": { "get": { "tags": [ "Roles" ], "operationId": "roles.listRoles", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "isSystem", "permissions", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "isSystem": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.roles.listRoles({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.roles.list_roles()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit roles list-roles" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/roles\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/roles';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List roles", "x-displayName": "List roles" }, "post": { "tags": [ "Roles" ], "operationId": "roles.createRole", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "isSystem", "permissions", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "isSystem": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "permissions" ], "properties": { "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "permissions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.roles.createRole({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.roles.create_role(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit roles create-role \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/roles\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/roles';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create role", "x-displayName": "Create role" } }, "/v1/roles/{roleId}": { "patch": { "tags": [ "Roles" ], "operationId": "roles.updateRole", "parameters": [ { "name": "roleId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "isSystem", "permissions", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "isSystem": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "permissions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.roles.updateRole({\n roleId: process.env.TX_AGENT_KIT_ROLE_ID ?? \"roleId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.roles.update_role(\n roleId=os.environ.get(\"TX_AGENT_KIT_ROLE_ID\", \"roleId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit roles update-role \\\n --request '{\"path\":{\"roleId\":\"roleId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let role_id = env::var(\"TX_AGENT_KIT_ROLE_ID\").unwrap_or_else(|_| \"roleId\".to_string());\n let url = format!(\"{}/v1/roles/{}\", base_url.trim_end_matches('/'), role_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final roleId = Platform.environment['TX_AGENT_KIT_ROLE_ID'] ?? 'roleId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/roles/$roleId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update role", "x-displayName": "Update role" }, "delete": { "tags": [ "Roles" ], "operationId": "roles.removeRole", "parameters": [ { "name": "roleId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.roles.removeRole({\n roleId: process.env.TX_AGENT_KIT_ROLE_ID ?? \"roleId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.roles.remove_role(\n roleId=os.environ.get(\"TX_AGENT_KIT_ROLE_ID\", \"roleId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit roles remove-role \\\n --request '{\"path\":{\"roleId\":\"roleId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let role_id = env::var(\"TX_AGENT_KIT_ROLE_ID\").unwrap_or_else(|_| \"roleId\".to_string());\n let url = format!(\"{}/v1/roles/{}\", base_url.trim_end_matches('/'), role_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final roleId = Platform.environment['TX_AGENT_KIT_ROLE_ID'] ?? 'roleId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/roles/$roleId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete role", "x-displayName": "Delete role" } }, "/v1/permissions": { "get": { "tags": [ "Permissions" ], "operationId": "permissions.getPermissionMap", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "admin", "member", "viewer" ], "properties": { "admin": { "type": "array", "items": { "type": "string", "enum": [ "view_organization", "manage_organization", "manage_organization_members", "manage_billing", "manage_team_members", "assign_roles", "create_teams", "delete_teams", "view_workflows", "create_workflows", "edit_workflows", "delete_workflows", "execute_workflows", "view_analytics", "export_analytics", "manage_integrations", "manage_api_keys", "view_assets", "upload_assets", "manage_assets", "delete_assets" ] } }, "member": { "type": "array", "items": { "type": "string", "enum": [ "view_organization", "manage_organization", "manage_organization_members", "manage_billing", "manage_team_members", "assign_roles", "create_teams", "delete_teams", "view_workflows", "create_workflows", "edit_workflows", "delete_workflows", "execute_workflows", "view_analytics", "export_analytics", "manage_integrations", "manage_api_keys", "view_assets", "upload_assets", "manage_assets", "delete_assets" ] } }, "viewer": { "type": "array", "items": { "type": "string", "enum": [ "view_organization", "manage_organization", "manage_organization_members", "manage_billing", "manage_team_members", "assign_roles", "create_teams", "delete_teams", "view_workflows", "create_workflows", "edit_workflows", "delete_workflows", "execute_workflows", "view_analytics", "export_analytics", "manage_integrations", "manage_api_keys", "view_assets", "upload_assets", "manage_assets", "delete_assets" ] } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.permissions.getPermissionMap()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.permissions.get_permission_map()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit permissions get-permission-map" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/permissions\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/permissions';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Permission definitions", "x-displayName": "Permission definitions" } }, "/v1/permissions/me": { "get": { "tags": [ "Permissions" ], "operationId": "permissions.getMyPermissions", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "isOwner", "permissions" ], "properties": { "organizationId": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ] }, "isOwner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view_organization", "manage_organization", "manage_organization_members", "manage_billing", "manage_team_members", "assign_roles", "create_teams", "delete_teams", "view_workflows", "create_workflows", "edit_workflows", "delete_workflows", "execute_workflows", "view_analytics", "export_analytics", "manage_integrations", "manage_api_keys", "view_assets", "upload_assets", "manage_assets", "delete_assets" ] } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.permissions.getMyPermissions()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.permissions.get_my_permissions()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit permissions get-my-permissions" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/permissions/me\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/permissions/me';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "My permissions", "x-displayName": "My permissions" } }, "/v1/auth/me": { "get": { "tags": [ "Auth" ], "operationId": "auth.me", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "email", "roles" ], "properties": { "userId": { "$ref": "#/components/schemas/UUID" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "member", "viewer" ] } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "view_organization", "manage_organization", "manage_organization_members", "manage_billing", "manage_team_members", "assign_roles", "create_teams", "delete_teams", "view_workflows", "create_workflows", "edit_workflows", "delete_workflows", "execute_workflows", "view_analytics", "export_analytics", "manage_integrations", "manage_api_keys", "view_assets", "upload_assets", "manage_assets", "delete_assets" ] } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.auth.me()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.auth.me()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit auth me" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/auth/me\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/auth/me';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Current principal", "x-displayName": "Current principal" } }, "/v1/email/unsubscribe": { "get": { "tags": [ "Email unsubscribe" ], "operationId": "emailUnsubscribe.getUnsubscribe", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "valid", "userId", "campaignId" ], "properties": { "valid": { "type": "boolean" }, "userId": { "type": "string" }, "campaignId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.emailUnsubscribe.getUnsubscribe({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.email_unsubscribe.get_unsubscribe()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit email-unsubscribe get-unsubscribe" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/email/unsubscribe\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/email/unsubscribe';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Unsubscribe", "x-displayName": "Unsubscribe" }, "post": { "tags": [ "Email unsubscribe" ], "operationId": "emailUnsubscribe.postUnsubscribe", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "unsubscribed", "userId", "campaignId" ], "properties": { "unsubscribed": { "type": "boolean" }, "userId": { "type": "string" }, "campaignId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.emailUnsubscribe.postUnsubscribe({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.email_unsubscribe.post_unsubscribe(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit email-unsubscribe post-unsubscribe \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/email/unsubscribe\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/email/unsubscribe';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Post unsubscribe", "x-displayName": "Post unsubscribe" } }, "/v1/email/unsubscribe/one-click": { "post": { "tags": [ "Email unsubscribe" ], "operationId": "emailUnsubscribe.postUnsubscribeOneClick", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "unsubscribed", "userId", "campaignId" ], "properties": { "unsubscribed": { "type": "boolean" }, "userId": { "type": "string" }, "campaignId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.emailUnsubscribe.postUnsubscribeOneClick({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.email_unsubscribe.post_unsubscribe_one_click()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit email-unsubscribe post-unsubscribe-one-click" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/email/unsubscribe/one-click\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/email/unsubscribe/one-click';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Post unsubscribe one click", "x-displayName": "Post unsubscribe one click" } }, "/v1/trace-learn/adaptive/next-question": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.selectTraceLearnNextQuestion", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "theta", "selected" ], "properties": { "theta": { "type": "number" }, "selected": { "anyOf": [ { "type": "object", "required": [ "questionId", "questionVersionId", "subjectId", "topicId", "difficulty", "difficultyB", "information", "topicMastery", "score", "reason" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "topicId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "difficultyB": { "type": "number" }, "information": { "type": "number", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "topicMastery": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "score": { "type": "number" }, "reason": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "subjectId" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "excludeQuestionIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "limit": { "type": "integer", "description": "a number between 1 and 200", "title": "between(1, 200)", "minimum": 1, "maximum": 200 }, "sessionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.selectTraceLearnNextQuestion({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.select_trace_learn_next_question(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn select-trace-learn-next-question \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/adaptive/next-question\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/adaptive/next-question';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Select trace learn next question", "x-displayName": "Select trace learn next question" } }, "/v1/trace-learn/answer-sheets/templates": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnAnswerSheetTemplates", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "questionCount", "optionCount", "linkedAssignmentId", "linkedAssignmentTitle", "generatedSheetCount", "pendingReviewCount", "sections" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "questionCount": { "type": "number" }, "optionCount": { "type": "number", "enum": [ 4, 5 ] }, "linkedAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "linkedAssignmentTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryGeneratedSheet": { "anyOf": [ { "type": "object", "required": [ "sheetCode", "studentName" ], "properties": { "sheetCode": { "type": "string" }, "studentName": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "generatedSheetCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "pendingReviewCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "sections": { "type": "array", "items": { "type": "object", "required": [ "name", "startQuestion", "endQuestion" ], "properties": { "name": { "type": "string" }, "startQuestion": { "type": "number" }, "endQuestion": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnAnswerSheetTemplates()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_answer_sheet_templates()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-answer-sheet-templates" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/answer-sheets/templates\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/answer-sheets/templates';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn answer sheet templates", "x-displayName": "List trace learn answer sheet templates" } }, "/v1/trace-learn/answer-sheets/templates/{templateId}": { "delete": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.deleteTraceLearnAnswerSheetTemplate", "parameters": [ { "name": "templateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.deleteTraceLearnAnswerSheetTemplate({\n templateId: process.env.TX_AGENT_KIT_TEMPLATE_ID ?? \"templateId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.delete_trace_learn_answer_sheet_template(\n templateId=os.environ.get(\"TX_AGENT_KIT_TEMPLATE_ID\", \"templateId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn delete-trace-learn-answer-sheet-template \\\n --request '{\"path\":{\"templateId\":\"templateId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let template_id = env::var(\"TX_AGENT_KIT_TEMPLATE_ID\").unwrap_or_else(|_| \"templateId\".to_string());\n let url = format!(\"{}/v1/trace-learn/answer-sheets/templates/{}\", base_url.trim_end_matches('/'), template_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final templateId = Platform.environment['TX_AGENT_KIT_TEMPLATE_ID'] ?? 'templateId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/answer-sheets/templates/$templateId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete trace learn answer sheet template", "x-displayName": "Delete trace learn answer sheet template" } }, "/v1/trace-learn/attempts": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.startTraceLearnAttempt", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "attempt" ], "properties": { "attempt": { "type": "object", "required": [ "id", "assignmentId", "studentAssignmentId", "studentId", "state", "startedAt", "submittedAt", "activeMs", "scoreBasisPoints" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "not-started", "in-progress", "submitted", "reviewed", "abandoned" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "submittedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "activeMs": { "type": "number" }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "assignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "summary": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.startTraceLearnAttempt({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.start_trace_learn_attempt(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn start-trace-learn-attempt \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/attempts\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/attempts';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Start trace learn attempt", "x-displayName": "Start trace learn attempt" } }, "/v1/trace-learn/attempts/{attemptId}/abandon": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.abandonTraceLearnAttempt", "parameters": [ { "name": "attemptId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "attempt" ], "properties": { "attempt": { "type": "object", "required": [ "id", "assignmentId", "studentAssignmentId", "studentId", "state", "startedAt", "submittedAt", "activeMs", "scoreBasisPoints" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "not-started", "in-progress", "submitted", "reviewed", "abandoned" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "submittedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "activeMs": { "type": "number" }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.abandonTraceLearnAttempt({\n attemptId: process.env.TX_AGENT_KIT_ATTEMPT_ID ?? \"attemptId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.abandon_trace_learn_attempt(\n attemptId=os.environ.get(\"TX_AGENT_KIT_ATTEMPT_ID\", \"attemptId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn abandon-trace-learn-attempt \\\n --request '{\"path\":{\"attemptId\":\"attemptId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let attempt_id = env::var(\"TX_AGENT_KIT_ATTEMPT_ID\").unwrap_or_else(|_| \"attemptId\".to_string());\n let url = format!(\"{}/v1/trace-learn/attempts/{}/abandon\", base_url.trim_end_matches('/'), attempt_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final attemptId = Platform.environment['TX_AGENT_KIT_ATTEMPT_ID'] ?? 'attemptId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/attempts/$attemptId/abandon';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Abandon trace learn attempt", "x-displayName": "Abandon trace learn attempt" } }, "/v1/trace-learn/attempts/{attemptId}/items": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.appendTraceLearnAttemptItem", "parameters": [ { "name": "attemptId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "item", "masteryUpdated", "serverGraded" ], "properties": { "item": { "type": "object", "required": [ "id", "attemptId", "questionId", "questionVersionId", "orderIndex", "correctness", "scoreBasisPoints", "createdAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "attemptId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "questionVersionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "orderIndex": { "type": "number" }, "correctness": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false }, "masteryUpdated": { "type": "boolean" }, "serverGraded": { "anyOf": [ { "type": "object", "required": [ "isCorrect", "correctAnswerIndex" ], "properties": { "isCorrect": { "type": "boolean" }, "correctAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "orderIndex", "servedSnapshot", "responseSnapshot" ], "properties": { "questionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "questionVersionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "orderIndex": { "type": "number" }, "servedSnapshot": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "responseSnapshot": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "correctness": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "masteryUpdate": { "anyOf": [ { "type": "object", "required": [ "subjectId", "topicId", "status", "confidenceBasisPoints", "evidence" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] }, "confidenceBasisPoints": { "type": "number", "description": "a number between 0 and 10000", "title": "between(0, 10000)", "minimum": 0, "maximum": 10000 }, "evidence": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.appendTraceLearnAttemptItem({\n attemptId: process.env.TX_AGENT_KIT_ATTEMPT_ID ?? \"attemptId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.append_trace_learn_attempt_item(\n attemptId=os.environ.get(\"TX_AGENT_KIT_ATTEMPT_ID\", \"attemptId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn append-trace-learn-attempt-item \\\n --request '{\"path\":{\"attemptId\":\"attemptId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let attempt_id = env::var(\"TX_AGENT_KIT_ATTEMPT_ID\").unwrap_or_else(|_| \"attemptId\".to_string());\n let url = format!(\"{}/v1/trace-learn/attempts/{}/items\", base_url.trim_end_matches('/'), attempt_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final attemptId = Platform.environment['TX_AGENT_KIT_ATTEMPT_ID'] ?? 'attemptId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/attempts/$attemptId/items';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Append trace learn attempt item", "x-displayName": "Append trace learn attempt item" } }, "/v1/trace-learn/attempts/{attemptId}/submit": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.submitTraceLearnAttempt", "parameters": [ { "name": "attemptId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "attempt", "resultSummary" ], "properties": { "attempt": { "type": "object", "required": [ "id", "assignmentId", "studentAssignmentId", "studentId", "state", "startedAt", "submittedAt", "activeMs", "scoreBasisPoints" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "not-started", "in-progress", "submitted", "reviewed", "abandoned" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "submittedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "activeMs": { "type": "number" }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "resultSummary": { "anyOf": [ { "type": "object", "required": [ "id", "studentId", "assignmentId", "assignmentTitle", "assignmentType", "submittedAt", "scorePercent", "correctCount", "questionCount", "timeTakenSeconds", "passed", "topicBreakdown", "mistakes", "remediation", "rewardDelta" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentTitle": { "type": "string" }, "assignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "submittedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "timeTakenSeconds": { "type": "number" }, "passed": { "type": "boolean" }, "topicBreakdown": { "type": "array", "items": { "type": "object", "required": [ "topicId", "topicName", "subjectId", "scorePercent", "correctCount", "questionCount", "status" ], "properties": { "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "mistakes": { "type": "array", "items": { "type": "object", "required": [ "questionId", "prompt", "selectedAnswerLabel", "correctAnswerLabel", "explanation", "topicName" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "selectedAnswerLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "correctAnswerLabel": { "type": "string" }, "explanation": { "type": "string" }, "topicName": { "type": "string" } }, "additionalProperties": false } }, "remediation": { "type": "object", "required": [ "nextLessonSegmentId", "nextLessonTitle", "practiceAssignmentId", "practiceAssignmentType", "focusTopicIds" ], "properties": { "nextLessonSegmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "nextLessonTitle": { "type": "string" }, "practiceAssignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "practiceAssignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "focusTopicIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "rewardDelta": { "type": "object", "required": [ "starsEarned", "gameSecondsEarned", "streakDays", "unlockedGameIds" ], "properties": { "starsEarned": { "type": "number" }, "gameSecondsEarned": { "type": "number" }, "streakDays": { "type": "number" }, "unlockedGameIds": { "type": "array", "items": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "activeMs", "scoreBasisPoints", "summary" ], "properties": { "activeMs": { "type": "number" }, "scoreBasisPoints": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "summary": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.submitTraceLearnAttempt({\n attemptId: process.env.TX_AGENT_KIT_ATTEMPT_ID ?? \"attemptId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.submit_trace_learn_attempt(\n attemptId=os.environ.get(\"TX_AGENT_KIT_ATTEMPT_ID\", \"attemptId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn submit-trace-learn-attempt \\\n --request '{\"path\":{\"attemptId\":\"attemptId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let attempt_id = env::var(\"TX_AGENT_KIT_ATTEMPT_ID\").unwrap_or_else(|_| \"attemptId\".to_string());\n let url = format!(\"{}/v1/trace-learn/attempts/{}/submit\", base_url.trim_end_matches('/'), attempt_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final attemptId = Platform.environment['TX_AGENT_KIT_ATTEMPT_ID'] ?? 'attemptId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/attempts/$attemptId/submit';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Submit trace learn attempt", "x-displayName": "Submit trace learn attempt" } }, "/v1/trace-learn/auth/student-login": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.traceLearnStudentLogin", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "actor", "session", "firstDestination" ], "properties": { "actor": { "type": "object", "required": [ "actorId", "role", "displayName", "organizationId", "teamId", "studentId", "learnerKey", "entitlementState", "adminGrants" ], "properties": { "actorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal" ] }, "displayName": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "learnerKey": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "adminGrants": { "type": "array", "items": { "type": "string", "enum": [ "content_admin", "platform_admin", "support" ] } } }, "additionalProperties": false }, "session": { "type": "object", "required": [ "kind", "sessionId", "token", "expiresAt" ], "properties": { "kind": { "type": "string", "enum": [ "student_pin" ] }, "sessionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "token": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "expiresAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false }, "firstDestination": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "username", "pin" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pin": { "type": "string", "description": "a string at most 4 character(s) long", "title": "maxLength(4)", "minLength": 4, "maxLength": 4 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.traceLearnStudentLogin({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.trace_learn_student_login(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn trace-learn-student-login \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/auth/student-login\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/auth/student-login';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Trace learn student login", "x-displayName": "Trace learn student login" } }, "/v1/trace-learn/billing/checkout": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.createTraceLearnBillingCheckout", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "checkoutId", "plan", "mode", "checkoutUrl", "dueTodayCents", "trialCreditCents", "expiresAt" ], "properties": { "checkoutId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "plan": { "type": "object", "required": [ "id", "tier", "name", "priceCents", "currency", "billingInterval", "features", "description", "payerKind", "maxStudents", "createdAt", "recommended" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tier": { "type": "string", "enum": [ "tutor_starter", "tutor_standard", "tutor_premium" ] }, "name": { "type": "string" }, "priceCents": { "type": "number", "description": "a number between 0 and 1000000", "title": "between(0, 1000000)", "minimum": 0, "maximum": 1000000 }, "currency": { "type": "string", "enum": [ "GBP", "USD" ] }, "billingInterval": { "type": "string", "enum": [ "monthly", "annual" ] }, "features": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "payerKind": { "type": "string", "enum": [ "tutor" ] }, "maxStudents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "recommended": { "type": "boolean" } }, "additionalProperties": false }, "mode": { "type": "string", "enum": [ "local", "stripe" ] }, "checkoutUrl": { "type": "string" }, "dueTodayCents": { "type": "number" }, "trialCreditCents": { "type": "number" }, "expiresAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "planId" ], "properties": { "planId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "successUrl": { "type": "string" }, "cancelUrl": { "type": "string" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.createTraceLearnBillingCheckout({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.create_trace_learn_billing_checkout(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn create-trace-learn-billing-checkout \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/billing/checkout\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/billing/checkout';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create trace learn billing checkout", "x-displayName": "Create trace learn billing checkout" } }, "/v1/trace-learn/billing/complete-local": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.completeTraceLearnBillingCheckout", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "subscription", "entitlementSummary", "message" ], "properties": { "subscription": { "type": "object", "required": [ "id", "payerKind", "payerId", "planId", "status", "startedAt", "trialEndsAt", "nextBillingDate", "cancelledAt", "seatsPurchased" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "payerKind": { "type": "string", "enum": [ "tutor" ] }, "payerId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "planId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "trialing", "active", "past_due", "paused", "cancelled", "expired" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "trialEndsAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "seatsPurchased": { "type": "number" } }, "additionalProperties": false }, "entitlementSummary": { "type": "object", "required": [ "state", "activeSeatCount", "learnerLimit", "diagnosticOnlyCount", "lockedReason", "managedBy" ], "properties": { "state": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "activeSeatCount": { "type": "number" }, "learnerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "diagnosticOnlyCount": { "type": "number" }, "lockedReason": { "anyOf": [ { "type": "string", "enum": [ "diagnostic_complete", "lesson_locked", "trial_expired", "payment_failed" ] }, { "type": "null" } ] }, "managedBy": { "type": "string", "enum": [ "tutor" ] } }, "additionalProperties": false }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "planId" ], "properties": { "planId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.completeTraceLearnBillingCheckout({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.complete_trace_learn_billing_checkout(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn complete-trace-learn-billing-checkout \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/billing/complete-local\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/billing/complete-local';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Complete trace learn billing checkout", "x-displayName": "Complete trace learn billing checkout" } }, "/v1/trace-learn/billing/overview": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnBillingOverview", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "plans", "activeSubscription", "seatEntitlements", "freeDiagnosticAccess", "invoices", "paymentMethods", "entitlementSummary", "projectionFreshness" ], "properties": { "plans": { "type": "array", "items": { "type": "object", "required": [ "id", "tier", "name", "priceCents", "currency", "billingInterval", "features", "description", "payerKind", "maxStudents", "createdAt", "recommended" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tier": { "type": "string", "enum": [ "tutor_starter", "tutor_standard", "tutor_premium" ] }, "name": { "type": "string" }, "priceCents": { "type": "number", "description": "a number between 0 and 1000000", "title": "between(0, 1000000)", "minimum": 0, "maximum": 1000000 }, "currency": { "type": "string", "enum": [ "GBP", "USD" ] }, "billingInterval": { "type": "string", "enum": [ "monthly", "annual" ] }, "features": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "payerKind": { "type": "string", "enum": [ "tutor" ] }, "maxStudents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "recommended": { "type": "boolean" } }, "additionalProperties": false } }, "activeSubscription": { "anyOf": [ { "type": "object", "required": [ "id", "payerKind", "payerId", "planId", "status", "startedAt", "trialEndsAt", "nextBillingDate", "cancelledAt", "seatsPurchased" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "payerKind": { "type": "string", "enum": [ "tutor" ] }, "payerId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "planId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "trialing", "active", "past_due", "paused", "cancelled", "expired" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "trialEndsAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "seatsPurchased": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "seatEntitlements": { "type": "array", "items": { "type": "object", "required": [ "id", "subscriptionId", "tutorId", "studentId", "state", "grantedAt", "revokedAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subscriptionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tutorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "active", "paused", "revoked" ] }, "grantedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "revokedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false } }, "freeDiagnosticAccess": { "type": "array", "items": { "type": "object", "required": [ "id", "parentEmail", "childUsername", "studentId", "diagnosticStartedAt", "diagnosticCompletedAt", "convertedTutorSubscriptionId", "createdAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "parentEmail": { "type": "string" }, "childUsername": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "diagnosticStartedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "diagnosticCompletedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "convertedTutorSubscriptionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } }, "invoices": { "type": "array", "items": { "type": "object", "required": [ "id", "subscriptionId", "amountCents", "currency", "status", "issuedAt", "dueAt", "paidAt", "periodStart", "periodEnd", "hostedInvoiceUrl" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subscriptionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "amountCents": { "type": "number" }, "currency": { "type": "string", "enum": [ "GBP", "USD" ] }, "status": { "type": "string", "enum": [ "paid", "unpaid", "failed", "refunded" ] }, "issuedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "dueAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "paidAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "periodStart": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "periodEnd": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "hostedInvoiceUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "paymentMethods": { "type": "array", "items": { "type": "object", "required": [ "id", "subscriptionId", "provider", "providerId", "paymentType", "last4", "brand", "expiryMonth", "expiryYear", "isDefault", "createdAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subscriptionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "provider": { "type": "string", "enum": [ "stripe", "manual" ] }, "providerId": { "type": "string" }, "paymentType": { "type": "string", "enum": [ "card", "bank" ] }, "last4": { "type": "string" }, "brand": { "anyOf": [ { "type": "string", "enum": [ "visa", "mastercard", "amex", "other" ] }, { "type": "null" } ] }, "expiryMonth": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiryYear": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } }, "entitlementSummary": { "type": "object", "required": [ "state", "activeSeatCount", "learnerLimit", "diagnosticOnlyCount", "lockedReason", "managedBy" ], "properties": { "state": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "activeSeatCount": { "type": "number" }, "learnerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "diagnosticOnlyCount": { "type": "number" }, "lockedReason": { "anyOf": [ { "type": "string", "enum": [ "diagnostic_complete", "lesson_locked", "trial_expired", "payment_failed" ] }, { "type": "null" } ] }, "managedBy": { "type": "string", "enum": [ "tutor" ] } }, "additionalProperties": false }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnBillingOverview()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_billing_overview()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-billing-overview" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/billing/overview\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/billing/overview';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn billing overview", "x-displayName": "Trace learn billing overview" } }, "/v1/trace-learn/billing/plans": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnBillingPlans", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "tier", "name", "priceCents", "currency", "billingInterval", "features", "description", "payerKind", "maxStudents", "createdAt", "recommended" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tier": { "type": "string", "enum": [ "tutor_starter", "tutor_standard", "tutor_premium" ] }, "name": { "type": "string" }, "priceCents": { "type": "number", "description": "a number between 0 and 1000000", "title": "between(0, 1000000)", "minimum": 0, "maximum": 1000000 }, "currency": { "type": "string", "enum": [ "GBP", "USD" ] }, "billingInterval": { "type": "string", "enum": [ "monthly", "annual" ] }, "features": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "payerKind": { "type": "string", "enum": [ "tutor" ] }, "maxStudents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "recommended": { "type": "boolean" } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnBillingPlans()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_billing_plans()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-billing-plans" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/billing/plans\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/billing/plans';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn billing plans", "x-displayName": "List trace learn billing plans" } }, "/v1/trace-learn/catalog/widgets": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnCatalogWidgets", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "reactName", "propsTypeName", "modes", "answerKind", "subjects" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "reactName": { "type": "string" }, "propsTypeName": { "type": "string" }, "modes": { "type": "array", "items": { "type": "string", "enum": [ "lesson", "question" ] } }, "answerKind": { "anyOf": [ { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, { "type": "null" } ] }, "subjects": { "type": "array", "items": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] } } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnCatalogWidgets()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_catalog_widgets()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-catalog-widgets" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/catalog/widgets\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/catalog/widgets';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn catalog widgets", "x-displayName": "List trace learn catalog widgets" } }, "/v1/trace-learn/compliance/children/{studentId}/erase": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.eraseTraceLearnChildData", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "auditId", "mode", "deletedCounts" ], "properties": { "auditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mode": { "type": "string" }, "deletedCounts": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "number" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "mode": { "type": "string", "enum": [ "delete", "anonymise" ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.eraseTraceLearnChildData({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.erase_trace_learn_child_data(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn erase-trace-learn-child-data \\\n --request '{\"path\":{\"studentId\":\"studentId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/compliance/children/{}/erase\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/compliance/children/$studentId/erase';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Erase trace learn child data", "x-displayName": "Erase trace learn child data" } }, "/v1/trace-learn/compliance/children/{studentId}/export": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.exportTraceLearnChildData", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "studentProfileId" ], "properties": { "studentProfileId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.exportTraceLearnChildData({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.export_trace_learn_child_data(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn export-trace-learn-child-data \\\n --request '{\"path\":{\"studentId\":\"studentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/compliance/children/{}/export\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/compliance/children/$studentId/export';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Export trace learn child data", "x-displayName": "Export trace learn child data" } }, "/v1/trace-learn/content-generation/jobs": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnContentGenerationJobs", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "status", "createdAt", "updatedAt", "requestedBy", "dryRun", "allowPaidModelCall", "provider", "model", "promptProfile", "requestedItemCount", "scope", "configSnapshot", "structuredOutputSchema", "catalogContext", "cacheKey", "resumabilityKey", "budget", "targetDistribution", "realisedDistribution", "runs", "draftBundle", "reviewGate", "metricSnapshot" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "dry_run_ready", "running", "awaiting_review", "approved", "rejected", "changes_requested", "budget_exhausted", "failed" ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "updatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "requestedBy": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "dryRun": { "type": "boolean" }, "allowPaidModelCall": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "model": { "type": "string" }, "promptProfile": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "requestedItemCount": { "type": "number" }, "scope": { "type": "object", "required": [ "curriculumId", "examFamilyId", "subjectId", "domainId", "subdomainId", "objective", "coverageBlueprintId" ], "properties": { "curriculumId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "examFamilyId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "objective": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "minLength": 8, "maxLength": 500 }, "coverageBlueprintId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false }, "configSnapshot": { "type": "object", "required": [ "id", "provider", "model", "sdkModelId", "promptProfiles", "globalBudgetCapCents", "perJobBudgetCapCents", "cacheTtlHours", "humanReviewRequired", "paidModelCallsBlocked" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "model": { "type": "string" }, "sdkModelId": { "type": "string" }, "promptProfiles": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "label", "temperature", "maxOutputTokens" ], "properties": { "id": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "version": { "type": "string" }, "label": { "type": "string" }, "temperature": { "type": "number" }, "maxOutputTokens": { "type": "number" } }, "additionalProperties": false } }, "globalBudgetCapCents": { "type": "number" }, "perJobBudgetCapCents": { "type": "number" }, "cacheTtlHours": { "type": "number" }, "humanReviewRequired": { "type": "boolean" }, "paidModelCallsBlocked": { "type": "boolean" } }, "additionalProperties": false }, "structuredOutputSchema": { "type": "object", "required": [ "name", "version", "requiredFields", "answerKind" ], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "answerKind": { "anyOf": [ { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "catalogContext": { "type": "object", "required": [ "source", "hash", "generatedAt", "widgetCount", "widgets" ], "properties": { "source": { "type": "string", "enum": [ "catalog" ] }, "hash": { "type": "string" }, "generatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "widgetCount": { "type": "number" }, "widgets": { "type": "array", "items": { "type": "object", "required": [ "id", "reactName", "answerKind", "propsTypeName" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "reactName": { "type": "string" }, "answerKind": { "anyOf": [ { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, { "type": "null" } ] }, "propsTypeName": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "cacheKey": { "type": "string" }, "resumabilityKey": { "type": "string" }, "budget": { "type": "object", "required": [ "currency", "maxBudgetCents", "spentBudgetCents", "remainingBudgetCents", "budgetCapReached" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ] }, "maxBudgetCents": { "type": "number" }, "spentBudgetCents": { "type": "number" }, "remainingBudgetCents": { "type": "number" }, "budgetCapReached": { "type": "boolean" } }, "additionalProperties": false }, "targetDistribution": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "domainId", "subdomainId", "weightPercent", "itemCount" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "weightPercent": { "type": "number" }, "itemCount": { "type": "number" } }, "additionalProperties": false } }, "realisedDistribution": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "domainId", "subdomainId", "weightPercent", "itemCount" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "weightPercent": { "type": "number" }, "itemCount": { "type": "number" } }, "additionalProperties": false } }, "runs": { "type": "array", "items": { "type": "object", "required": [ "id", "provider", "transport", "model", "status", "startedAt", "completedAt", "costCents", "cached", "cacheKey", "providerRunId" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "transport": { "type": "string", "enum": [ "dry-run", "api" ] }, "model": { "type": "string" }, "status": { "type": "string", "enum": [ "dry_run_ready", "running", "awaiting_review", "approved", "rejected", "changes_requested", "budget_exhausted", "failed" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "completedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "costCents": { "type": "number" }, "cached": { "type": "boolean" }, "cacheKey": { "type": "string" }, "providerRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "draftBundle": { "anyOf": [ { "type": "object", "required": [ "id", "title", "objective", "lessonBlockCount", "questionCount", "widgetIds", "answerKeyStatus", "previewPath", "alignment" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "objective": { "type": "string" }, "lessonBlockCount": { "type": "number" }, "questionCount": { "type": "number" }, "widgetIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "answerKeyStatus": { "type": "string", "enum": [ "included", "missing" ] }, "previewPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alignment": { "type": "object", "required": [ "objectiveLinked", "answerKeyIncluded", "widgetCompatible", "reviewGateIncluded" ], "properties": { "objectiveLinked": { "type": "boolean" }, "answerKeyIncluded": { "type": "boolean" }, "widgetCompatible": { "type": "boolean" }, "reviewGateIncluded": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "reviewGate": { "type": "object", "required": [ "status", "requiredChecks", "completedChecks", "reviewedBy", "reviewedAt", "notes" ], "properties": { "status": { "type": "string", "enum": [ "requires_review", "approved", "rejected", "changes_requested" ] }, "requiredChecks": { "type": "array", "items": { "type": "string", "enum": [ "human_visual_review", "answer_key_verified", "widget_preview_rendered", "coverage_alignment_checked", "age_suitability_checked" ] } }, "completedChecks": { "type": "array", "items": { "type": "string", "enum": [ "human_visual_review", "answer_key_verified", "widget_preview_rendered", "coverage_alignment_checked", "age_suitability_checked" ] } }, "reviewedBy": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "reviewedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "metricSnapshot": { "type": "object", "required": [ "promptProfile", "model", "targetCoverageItems", "realisedCoverageItems", "approvalRatePercent", "rejectionReasons" ], "properties": { "promptProfile": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "model": { "type": "string" }, "targetCoverageItems": { "type": "number" }, "realisedCoverageItems": { "type": "number" }, "approvalRatePercent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rejectionReasons": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnContentGenerationJobs()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_content_generation_jobs()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-content-generation-jobs" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/content-generation/jobs\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/content-generation/jobs';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn content generation jobs", "x-displayName": "List trace learn content generation jobs" }, "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.createTraceLearnContentGenerationJob", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "status", "createdAt", "updatedAt", "requestedBy", "dryRun", "allowPaidModelCall", "provider", "model", "promptProfile", "requestedItemCount", "scope", "configSnapshot", "structuredOutputSchema", "catalogContext", "cacheKey", "resumabilityKey", "budget", "targetDistribution", "realisedDistribution", "runs", "draftBundle", "reviewGate", "metricSnapshot" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "dry_run_ready", "running", "awaiting_review", "approved", "rejected", "changes_requested", "budget_exhausted", "failed" ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "updatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "requestedBy": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "dryRun": { "type": "boolean" }, "allowPaidModelCall": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "model": { "type": "string" }, "promptProfile": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "requestedItemCount": { "type": "number" }, "scope": { "type": "object", "required": [ "curriculumId", "examFamilyId", "subjectId", "domainId", "subdomainId", "objective", "coverageBlueprintId" ], "properties": { "curriculumId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "examFamilyId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "objective": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "minLength": 8, "maxLength": 500 }, "coverageBlueprintId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false }, "configSnapshot": { "type": "object", "required": [ "id", "provider", "model", "sdkModelId", "promptProfiles", "globalBudgetCapCents", "perJobBudgetCapCents", "cacheTtlHours", "humanReviewRequired", "paidModelCallsBlocked" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "model": { "type": "string" }, "sdkModelId": { "type": "string" }, "promptProfiles": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "label", "temperature", "maxOutputTokens" ], "properties": { "id": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "version": { "type": "string" }, "label": { "type": "string" }, "temperature": { "type": "number" }, "maxOutputTokens": { "type": "number" } }, "additionalProperties": false } }, "globalBudgetCapCents": { "type": "number" }, "perJobBudgetCapCents": { "type": "number" }, "cacheTtlHours": { "type": "number" }, "humanReviewRequired": { "type": "boolean" }, "paidModelCallsBlocked": { "type": "boolean" } }, "additionalProperties": false }, "structuredOutputSchema": { "type": "object", "required": [ "name", "version", "requiredFields", "answerKind" ], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "requiredFields": { "type": "array", "items": { "type": "string" } }, "answerKind": { "anyOf": [ { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "catalogContext": { "type": "object", "required": [ "source", "hash", "generatedAt", "widgetCount", "widgets" ], "properties": { "source": { "type": "string", "enum": [ "catalog" ] }, "hash": { "type": "string" }, "generatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "widgetCount": { "type": "number" }, "widgets": { "type": "array", "items": { "type": "object", "required": [ "id", "reactName", "answerKind", "propsTypeName" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "reactName": { "type": "string" }, "answerKind": { "anyOf": [ { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, { "type": "null" } ] }, "propsTypeName": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "cacheKey": { "type": "string" }, "resumabilityKey": { "type": "string" }, "budget": { "type": "object", "required": [ "currency", "maxBudgetCents", "spentBudgetCents", "remainingBudgetCents", "budgetCapReached" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ] }, "maxBudgetCents": { "type": "number" }, "spentBudgetCents": { "type": "number" }, "remainingBudgetCents": { "type": "number" }, "budgetCapReached": { "type": "boolean" } }, "additionalProperties": false }, "targetDistribution": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "domainId", "subdomainId", "weightPercent", "itemCount" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "weightPercent": { "type": "number" }, "itemCount": { "type": "number" } }, "additionalProperties": false } }, "realisedDistribution": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "domainId", "subdomainId", "weightPercent", "itemCount" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "weightPercent": { "type": "number" }, "itemCount": { "type": "number" } }, "additionalProperties": false } }, "runs": { "type": "array", "items": { "type": "object", "required": [ "id", "provider", "transport", "model", "status", "startedAt", "completedAt", "costCents", "cached", "cacheKey", "providerRunId" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "provider": { "type": "string", "enum": [ "dry-run", "gemini", "openrouter" ] }, "transport": { "type": "string", "enum": [ "dry-run", "api" ] }, "model": { "type": "string" }, "status": { "type": "string", "enum": [ "dry_run_ready", "running", "awaiting_review", "approved", "rejected", "changes_requested", "budget_exhausted", "failed" ] }, "startedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "completedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "costCents": { "type": "number" }, "cached": { "type": "boolean" }, "cacheKey": { "type": "string" }, "providerRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "draftBundle": { "anyOf": [ { "type": "object", "required": [ "id", "title", "objective", "lessonBlockCount", "questionCount", "widgetIds", "answerKeyStatus", "previewPath", "alignment" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "objective": { "type": "string" }, "lessonBlockCount": { "type": "number" }, "questionCount": { "type": "number" }, "widgetIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "answerKeyStatus": { "type": "string", "enum": [ "included", "missing" ] }, "previewPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alignment": { "type": "object", "required": [ "objectiveLinked", "answerKeyIncluded", "widgetCompatible", "reviewGateIncluded" ], "properties": { "objectiveLinked": { "type": "boolean" }, "answerKeyIncluded": { "type": "boolean" }, "widgetCompatible": { "type": "boolean" }, "reviewGateIncluded": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "reviewGate": { "type": "object", "required": [ "status", "requiredChecks", "completedChecks", "reviewedBy", "reviewedAt", "notes" ], "properties": { "status": { "type": "string", "enum": [ "requires_review", "approved", "rejected", "changes_requested" ] }, "requiredChecks": { "type": "array", "items": { "type": "string", "enum": [ "human_visual_review", "answer_key_verified", "widget_preview_rendered", "coverage_alignment_checked", "age_suitability_checked" ] } }, "completedChecks": { "type": "array", "items": { "type": "string", "enum": [ "human_visual_review", "answer_key_verified", "widget_preview_rendered", "coverage_alignment_checked", "age_suitability_checked" ] } }, "reviewedBy": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "reviewedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "metricSnapshot": { "type": "object", "required": [ "promptProfile", "model", "targetCoverageItems", "realisedCoverageItems", "approvalRatePercent", "rejectionReasons" ], "properties": { "promptProfile": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "model": { "type": "string" }, "targetCoverageItems": { "type": "number" }, "realisedCoverageItems": { "type": "number" }, "approvalRatePercent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rejectionReasons": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "promptProfile", "scope", "requestedItemCount", "maxBudgetCents", "dryRun", "allowPaidModelCall" ], "properties": { "promptProfile": { "type": "string", "enum": [ "production_question", "learning_content", "lesson_bundle", "hint", "explanation", "motivational_copy" ] }, "scope": { "type": "object", "required": [ "curriculumId", "examFamilyId", "subjectId", "domainId", "subdomainId", "objective", "coverageBlueprintId" ], "properties": { "curriculumId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "examFamilyId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "domainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "subdomainId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "objective": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "minLength": 8, "maxLength": 500 }, "coverageBlueprintId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false }, "requestedItemCount": { "type": "integer", "description": "a number between 1 and 20", "title": "between(1, 20)", "minimum": 1, "maximum": 20 }, "maxBudgetCents": { "type": "integer", "description": "a number between 0 and 20000", "title": "between(0, 20000)", "minimum": 0, "maximum": 20000 }, "dryRun": { "type": "boolean", "enum": [ true ] }, "allowPaidModelCall": { "type": "boolean", "enum": [ false ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.createTraceLearnContentGenerationJob({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.create_trace_learn_content_generation_job(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn create-trace-learn-content-generation-job \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/content-generation/jobs\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/content-generation/jobs';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create trace learn content generation job", "x-displayName": "Create trace learn content generation job" } }, "/v1/trace-learn/diagnostic/results": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnDiagnosticResult", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "studentId", "initialPassProbability", "baselineScoreBySubject", "initialTopicMastery", "recommendedNextAction" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "initialPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "baselineScoreBySubject": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "score" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } }, "initialTopicMastery": { "type": "array", "items": { "type": "object", "required": [ "id", "subjectId", "name", "score", "status" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "recommendedNextAction": { "type": "object", "required": [ "type", "label", "targetId" ], "properties": { "type": { "type": "string", "enum": [ "lesson", "mini-test", "test", "practice", "break" ] }, "label": { "type": "string" }, "targetId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnDiagnosticResult()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_diagnostic_result()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-diagnostic-result" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/diagnostic/results\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/diagnostic/results';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn diagnostic result", "x-displayName": "Trace learn diagnostic result" } }, "/v1/trace-learn/diagnostic/runtime": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnDiagnosticRuntime", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "status", "questionCount", "completedCount", "questions" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "not-started", "in-progress", "completed" ] }, "questionCount": { "type": "number" }, "completedCount": { "type": "number" }, "questions": { "type": "array", "items": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnDiagnosticRuntime()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_diagnostic_runtime()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-diagnostic-runtime" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/diagnostic/runtime\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/diagnostic/runtime';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn diagnostic runtime", "x-displayName": "Trace learn diagnostic runtime" } }, "/v1/trace-learn/diagnostic/start": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.startTraceLearnDiagnostic", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "studentId", "attemptNumber", "questionCount", "questions" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "attemptNumber": { "type": "integer", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "questionCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "questions": { "type": "array", "items": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.startTraceLearnDiagnostic()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.start_trace_learn_diagnostic()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn start-trace-learn-diagnostic" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/diagnostic/start\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/diagnostic/start';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.post(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Start trace learn diagnostic", "x-displayName": "Start trace learn diagnostic" } }, "/v1/trace-learn/diagnostic/submit": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.submitTraceLearnDiagnostic", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "diagnosticResultId", "studentId", "attemptNumber", "questionCount", "correctCount", "subjectAbility", "topicMastery" ], "properties": { "diagnosticResultId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "attemptNumber": { "type": "integer", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "questionCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "correctCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "subjectAbility": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "theta", "thetaStandardError", "scorePercent", "answered", "correct" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "theta": { "type": "number" }, "thetaStandardError": { "type": "number" }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "answered": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "correct": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 } }, "additionalProperties": false } }, "topicMastery": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "topicId", "pKnown", "observationCount", "correctCount" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pKnown": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "observationCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "correctCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "responses" ], "properties": { "responses": { "type": "array", "items": { "type": "object", "required": [ "questionId", "subjectId", "topicId", "difficulty" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "selectedAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "$id": "/schemas/unknown", "title": "unknown" }, "correct": { "type": "boolean" } }, "additionalProperties": false } }, "activeMs": { "type": "number" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.submitTraceLearnDiagnostic({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.submit_trace_learn_diagnostic(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn submit-trace-learn-diagnostic \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/diagnostic/submit\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/diagnostic/submit';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Submit trace learn diagnostic", "x-displayName": "Submit trace learn diagnostic" } }, "/v1/trace-learn/events": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.traceLearnIngestTelemetry", "parameters": [], "security": [], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted", "duplicate", "rejected", "projectionScheduled" ], "properties": { "accepted": { "type": "number" }, "duplicate": { "type": "number" }, "rejected": { "type": "number" }, "projectionScheduled": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sessionId", "learnerKey", "schemaVersion", "sdkVersion", "events" ], "properties": { "sessionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "learnerKey": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "schemaVersion": { "type": "number" }, "sdkVersion": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "required": [ "type", "atMs", "payload" ], "properties": { "eventId": { "type": "string" }, "type": { "type": "string" }, "atMs": { "type": "number" }, "payload": { "$id": "/schemas/unknown", "title": "unknown" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.traceLearnIngestTelemetry({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.trace_learn_ingest_telemetry(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn trace-learn-ingest-telemetry \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/events\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/events';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Trace learn ingest telemetry", "x-displayName": "Trace learn ingest telemetry" } }, "/v1/trace-learn/homework/{type}/{assignmentId}/runtime": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnHomeworkRuntime", "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "required": true }, { "name": "assignmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignment", "state", "timer", "feedback", "lesson", "questions" ], "properties": { "assignment": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "state": { "type": "string", "enum": [ "not-started", "in-progress", "submitted", "reviewed", "abandoned" ] }, "timer": { "type": "object", "required": [ "totalSeconds", "startsAtPhase", "allowPause", "showTimeRemaining" ], "properties": { "totalSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "startsAtPhase": { "type": "string", "enum": [ "intro", "lesson", "question" ] }, "allowPause": { "type": "boolean" }, "showTimeRemaining": { "type": "boolean" } }, "additionalProperties": false }, "feedback": { "type": "object", "required": [ "immediate", "allowRetryInPlace", "failedRoute" ], "properties": { "immediate": { "type": "boolean" }, "allowRetryInPlace": { "type": "boolean" }, "failedRoute": { "type": "string", "enum": [ "learn", "review", "none" ] } }, "additionalProperties": false }, "lesson": { "anyOf": [ { "type": "object", "required": [ "id", "segmentId", "title", "subjectId", "subjectName", "topicId", "topicName", "durationSeconds", "blocks", "quiz", "source" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "segmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "durationSeconds": { "type": "number" }, "blocks": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "title", "content", "items", "visualParts" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "heading", "text", "example", "tip", "vocabulary", "visual-breakdown", "did-you-know", "memory-aid", "challenge-preview", "word-tree" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "term", "definition" ], "properties": { "term": { "type": "string" }, "definition": { "type": "string" } }, "additionalProperties": false } }, "visualParts": { "type": "array", "items": { "type": "object", "required": [ "label", "value", "description" ], "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "quiz": { "type": "array", "items": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "source": { "type": "string", "enum": [ "fixture", "published_content" ] } }, "additionalProperties": false }, { "type": "null" } ] }, "questions": { "type": "array", "items": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnHomeworkRuntime({\n type: process.env.TX_AGENT_KIT_TYPE ?? \"type\",\n assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? \"assignmentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_homework_runtime(\n type=os.environ.get(\"TX_AGENT_KIT_TYPE\", \"type\"),\n assignmentId=os.environ.get(\"TX_AGENT_KIT_ASSIGNMENT_ID\", \"assignmentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-homework-runtime \\\n --request '{\"path\":{\"type\":\"type\",\"assignmentId\":\"assignmentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let type = env::var(\"TX_AGENT_KIT_TYPE\").unwrap_or_else(|_| \"type\".to_string());\n let assignment_id = env::var(\"TX_AGENT_KIT_ASSIGNMENT_ID\").unwrap_or_else(|_| \"assignmentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/homework/{}/{}/runtime\", base_url.trim_end_matches('/'), type, assignment_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final type = Platform.environment['TX_AGENT_KIT_TYPE'] ?? 'type';\n final assignmentId = Platform.environment['TX_AGENT_KIT_ASSIGNMENT_ID'] ?? 'assignmentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/homework/$type/$assignmentId/runtime';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn homework runtime", "x-displayName": "Trace learn homework runtime" } }, "/v1/trace-learn/learn/complete": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.completeTraceLearnLesson", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "completion", "created" ], "properties": { "completion": { "type": "object", "required": [ "id", "studentId", "lessonId", "segmentId", "lessonTitle", "subjectId", "attemptNumber", "status", "passed", "scoreCorrect", "scoreTotal", "scorePercent", "activeMs", "startedAt", "completedAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "lessonId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "segmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lessonTitle": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "attemptNumber": { "type": "integer", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "status": { "type": "string" }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "scoreCorrect": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "scoreTotal": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "scorePercent": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "activeMs": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "completedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false }, "created": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "segmentId" ], "properties": { "segmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "score": { "anyOf": [ { "type": "object", "required": [ "correct", "total" ], "properties": { "correct": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "total": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 } }, "additionalProperties": false }, { "type": "null" } ] }, "activeMs": { "type": "number", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "startedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.completeTraceLearnLesson({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.complete_trace_learn_lesson(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn complete-trace-learn-lesson \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/learn/complete\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/learn/complete';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Complete trace learn lesson", "x-displayName": "Complete trace learn lesson" } }, "/v1/trace-learn/learn/grade": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.gradeTraceLearnLessonQuiz", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "correct", "total", "gradable", "passed", "scorePercent", "perQuestion" ], "properties": { "correct": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "total": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "gradable": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "scorePercent": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "perQuestion": { "type": "array", "items": { "type": "object", "required": [ "questionId", "correct", "gradable" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "correct": { "type": "boolean" }, "gradable": { "type": "boolean" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "segmentId", "selections" ], "properties": { "segmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "selections": { "type": "array", "items": { "type": "object", "required": [ "questionId", "selectedAnswerIndex" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "selectedAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.gradeTraceLearnLessonQuiz({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.grade_trace_learn_lesson_quiz(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn grade-trace-learn-lesson-quiz \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/learn/grade\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/learn/grade';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Grade trace learn lesson quiz", "x-displayName": "Grade trace learn lesson quiz" } }, "/v1/trace-learn/learning-segments/{segmentId}/runtime": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnLessonRuntime", "parameters": [ { "name": "segmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "segmentId", "title", "subjectId", "subjectName", "topicId", "topicName", "durationSeconds", "blocks", "quiz", "source" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "segmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "durationSeconds": { "type": "number" }, "blocks": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "title", "content", "items", "visualParts" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "heading", "text", "example", "tip", "vocabulary", "visual-breakdown", "did-you-know", "memory-aid", "challenge-preview", "word-tree" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "term", "definition" ], "properties": { "term": { "type": "string" }, "definition": { "type": "string" } }, "additionalProperties": false } }, "visualParts": { "type": "array", "items": { "type": "object", "required": [ "label", "value", "description" ], "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "quiz": { "type": "array", "items": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "source": { "type": "string", "enum": [ "fixture", "published_content" ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnLessonRuntime({\n segmentId: process.env.TX_AGENT_KIT_SEGMENT_ID ?? \"segmentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_lesson_runtime(\n segmentId=os.environ.get(\"TX_AGENT_KIT_SEGMENT_ID\", \"segmentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-lesson-runtime \\\n --request '{\"path\":{\"segmentId\":\"segmentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let segment_id = env::var(\"TX_AGENT_KIT_SEGMENT_ID\").unwrap_or_else(|_| \"segmentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/learning-segments/{}/runtime\", base_url.trim_end_matches('/'), segment_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final segmentId = Platform.environment['TX_AGENT_KIT_SEGMENT_ID'] ?? 'segmentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/learning-segments/$segmentId/runtime';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn lesson runtime", "x-displayName": "Trace learn lesson runtime" } }, "/v1/trace-learn/notification-preferences": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnNotificationPreferences", "parameters": [ { "name": "role", "in": "query", "schema": { "type": "string", "enum": [ "parent", "tutor" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "userAccountId", "role", "emailHomeworkCompletion", "emailHomeworkReminders", "emailWeeklyDigest", "emailSixWeeklySummary", "digestDayOfWeek", "pushEnabled", "quietHoursStart", "quietHoursEnd", "updatedAt" ], "properties": { "userAccountId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "parent", "tutor" ] }, "emailHomeworkCompletion": { "type": "boolean" }, "emailHomeworkReminders": { "type": "boolean" }, "emailWeeklyDigest": { "type": "boolean" }, "emailSixWeeklySummary": { "type": "boolean" }, "digestDayOfWeek": { "type": "integer", "description": "a number between 0 and 6", "title": "between(0, 6)", "minimum": 0, "maximum": 6 }, "pushEnabled": { "type": "boolean" }, "quietHoursStart": { "type": "string" }, "quietHoursEnd": { "type": "string" }, "updatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnNotificationPreferences({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_notification_preferences()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-notification-preferences" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/notification-preferences\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/notification-preferences';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn notification preferences", "x-displayName": "Trace learn notification preferences" }, "patch": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.updateTraceLearnNotificationPreferences", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "userAccountId", "role", "emailHomeworkCompletion", "emailHomeworkReminders", "emailWeeklyDigest", "emailSixWeeklySummary", "digestDayOfWeek", "pushEnabled", "quietHoursStart", "quietHoursEnd", "updatedAt" ], "properties": { "userAccountId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "parent", "tutor" ] }, "emailHomeworkCompletion": { "type": "boolean" }, "emailHomeworkReminders": { "type": "boolean" }, "emailWeeklyDigest": { "type": "boolean" }, "emailSixWeeklySummary": { "type": "boolean" }, "digestDayOfWeek": { "type": "integer", "description": "a number between 0 and 6", "title": "between(0, 6)", "minimum": 0, "maximum": 6 }, "pushEnabled": { "type": "boolean" }, "quietHoursStart": { "type": "string" }, "quietHoursEnd": { "type": "string" }, "updatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "enum": [ "parent", "tutor" ] }, "emailHomeworkCompletion": { "type": "boolean" }, "emailHomeworkReminders": { "type": "boolean" }, "emailWeeklyDigest": { "type": "boolean" }, "emailSixWeeklySummary": { "type": "boolean" }, "digestDayOfWeek": { "type": "integer", "description": "a number between 0 and 6", "title": "between(0, 6)", "minimum": 0, "maximum": 6 }, "pushEnabled": { "type": "boolean" }, "quietHoursStart": { "type": "string", "description": "a string at most 5 character(s) long", "title": "maxLength(5)", "minLength": 5, "maxLength": 5 }, "quietHoursEnd": { "type": "string", "description": "a string at most 5 character(s) long", "title": "maxLength(5)", "minLength": 5, "maxLength": 5 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.updateTraceLearnNotificationPreferences({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.update_trace_learn_notification_preferences(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn update-trace-learn-notification-preferences \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/notification-preferences\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/notification-preferences';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update trace learn notification preferences", "x-displayName": "Update trace learn notification preferences" } }, "/v1/trace-learn/notifications": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnNotifications", "parameters": [ { "name": "role", "in": "query", "schema": { "type": "string", "enum": [ "parent", "tutor" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "recipientRole", "recipientId", "recipientEmail", "subject", "status", "sentAt", "templateId", "studentId", "createdAt", "readAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "homework_completion", "homework_reminder", "weekly_digest", "six_weekly_summary", "paper_assigned", "paper_completed", "streak_milestone", "diagnostic_completed", "student_welcome", "subscription_payment_failed", "subscription_renewed" ] }, "recipientRole": { "type": "string", "enum": [ "parent", "tutor" ] }, "recipientId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "recipientEmail": { "type": "string" }, "subject": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sent", "failed", "bounced" ] }, "sentAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "templateId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "readAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnNotifications({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_notifications()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-notifications" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/notifications\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/notifications';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn notifications", "x-displayName": "List trace learn notifications" } }, "/v1/trace-learn/notifications/templates": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnNotificationTemplates", "parameters": [ { "name": "role", "in": "query", "schema": { "type": "string", "enum": [ "parent", "tutor" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "recipientRole", "subjectTemplate", "bodyTemplate", "variables", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "homework_completion", "homework_reminder", "weekly_digest", "six_weekly_summary", "paper_assigned", "paper_completed", "streak_milestone", "diagnostic_completed", "student_welcome", "subscription_payment_failed", "subscription_renewed" ] }, "recipientRole": { "type": "string", "enum": [ "parent", "tutor" ] }, "subjectTemplate": { "type": "string" }, "bodyTemplate": { "type": "string" }, "variables": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "updatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnNotificationTemplates({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_notification_templates()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-notification-templates" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/notifications/templates\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/notifications/templates';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn notification templates", "x-displayName": "List trace learn notification templates" } }, "/v1/trace-learn/onboarding/options": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnOnboardingOptions", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "roles", "yearGroups", "examFamilies", "subjects", "avatars", "tutorStudentCountBands", "tutorPainPoints", "studentCredentialRules" ], "properties": { "roles": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "description", "firstDestination" ], "properties": { "id": { "type": "string", "enum": [ "student", "tutor", "parent" ] }, "label": { "type": "string" }, "description": { "type": "string" }, "firstDestination": { "type": "string" } }, "additionalProperties": false } }, "yearGroups": { "type": "array", "items": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] } }, "examFamilies": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "defaultForBuckinghamshire" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" }, "defaultForBuckinghamshire": { "type": "boolean" } }, "additionalProperties": false } }, "subjects": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "avatars": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "icon" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false } }, "tutorStudentCountBands": { "type": "array", "items": { "type": "string", "enum": [ "1-5", "6-15", "16-30", "30+" ] } }, "tutorPainPoints": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "enum": [ "finding-practice-questions", "tracking-progress", "assigning-homework", "reporting-to-parents" ] }, "label": { "type": "string" } }, "additionalProperties": false } }, "studentCredentialRules": { "type": "object", "required": [ "usernameMinLength", "pinLength", "childrenUseEmailLogin" ], "properties": { "usernameMinLength": { "type": "number" }, "pinLength": { "type": "number" }, "childrenUseEmailLogin": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnOnboardingOptions()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_onboarding_options()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-onboarding-options" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/onboarding/options\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/onboarding/options';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn onboarding options", "x-displayName": "Trace learn onboarding options" } }, "/v1/trace-learn/onboarding/parent-child": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.completeTraceLearnParentChildOnboarding", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "actor", "profile", "student", "links", "entitlement", "firstDestination", "nextSteps" ], "properties": { "actor": { "type": "object", "required": [ "actorId", "role", "displayName", "organizationId", "teamId", "studentId", "learnerKey", "entitlementState", "adminGrants" ], "properties": { "actorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal" ] }, "displayName": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "learnerKey": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "adminGrants": { "type": "array", "items": { "type": "string", "enum": [ "content_admin", "platform_admin", "support" ] } } }, "additionalProperties": false }, "profile": { "type": "object", "required": [ "role", "displayName", "organizationId", "teamId", "studentId" ], "properties": { "role": { "type": "string", "enum": [ "student", "tutor", "parent" ] }, "displayName": { "type": "string" }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false }, "student": { "anyOf": [ { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "learnerKey", "credential" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "learnerKey": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "state", "studentId" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "parent-child", "tutor-student" ] }, "state": { "type": "string", "enum": [ "active", "invited", "pending_parent", "pending_tutor" ] }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } }, "entitlement": { "type": "object", "required": [ "state", "source" ], "properties": { "state": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "source": { "type": "string", "enum": [ "free_diagnostic", "subscription", "trial", "admin_grant" ] } }, "additionalProperties": false }, "firstDestination": { "type": "string" }, "nextSteps": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "parentDisplayName", "parentEmail", "childDisplayName", "childUsername", "childPin", "yearGroup", "targetSchool", "examFamilyId", "subjectIds", "avatarId" ], "properties": { "parentDisplayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "parentEmail": { "type": "string", "description": "a string at most 254 character(s) long", "title": "maxLength(254)", "minLength": 3, "maxLength": 254 }, "childDisplayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "childUsername": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "childPin": { "type": "string", "description": "a string at most 4 character(s) long", "title": "maxLength(4)", "minLength": 4, "maxLength": 4 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "maxLength": 160 }, { "type": "null" } ] }, "examFamilyId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectIds": { "type": "array", "items": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] } }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tutorInviteEmail": { "anyOf": [ { "type": "string", "description": "a string at most 254 character(s) long", "title": "maxLength(254)", "maxLength": 254 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.completeTraceLearnParentChildOnboarding({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.complete_trace_learn_parent_child_onboarding(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn complete-trace-learn-parent-child-onboarding \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/onboarding/parent-child\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/onboarding/parent-child';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Complete trace learn parent child onboarding", "x-displayName": "Complete trace learn parent child onboarding" } }, "/v1/trace-learn/onboarding/tutor": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.completeTraceLearnTutorOnboarding", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "actor", "profile", "student", "links", "entitlement", "firstDestination", "nextSteps" ], "properties": { "actor": { "type": "object", "required": [ "actorId", "role", "displayName", "organizationId", "teamId", "studentId", "learnerKey", "entitlementState", "adminGrants" ], "properties": { "actorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal" ] }, "displayName": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "learnerKey": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "adminGrants": { "type": "array", "items": { "type": "string", "enum": [ "content_admin", "platform_admin", "support" ] } } }, "additionalProperties": false }, "profile": { "type": "object", "required": [ "role", "displayName", "organizationId", "teamId", "studentId" ], "properties": { "role": { "type": "string", "enum": [ "student", "tutor", "parent" ] }, "displayName": { "type": "string" }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false }, "student": { "anyOf": [ { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "learnerKey", "credential" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "learnerKey": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "state", "studentId" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "parent-child", "tutor-student" ] }, "state": { "type": "string", "enum": [ "active", "invited", "pending_parent", "pending_tutor" ] }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } }, "entitlement": { "type": "object", "required": [ "state", "source" ], "properties": { "state": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "source": { "type": "string", "enum": [ "free_diagnostic", "subscription", "trial", "admin_grant" ] } }, "additionalProperties": false }, "firstDestination": { "type": "string" }, "nextSteps": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tutorDisplayName", "tutorEmail", "practiceName", "studentCountBand", "examFamilyIds", "painPoint", "defaultExamFamilyId" ], "properties": { "tutorDisplayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "tutorEmail": { "type": "string", "description": "a string at most 254 character(s) long", "title": "maxLength(254)", "minLength": 3, "maxLength": 254 }, "practiceName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "studentCountBand": { "type": "string", "enum": [ "1-5", "6-15", "16-30", "30+" ] }, "examFamilyIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "painPoint": { "type": "string", "enum": [ "finding-practice-questions", "tracking-progress", "assigning-homework", "reporting-to-parents" ] }, "defaultExamFamilyId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.completeTraceLearnTutorOnboarding({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.complete_trace_learn_tutor_onboarding(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn complete-trace-learn-tutor-onboarding \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/onboarding/tutor\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/onboarding/tutor';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Complete trace learn tutor onboarding", "x-displayName": "Complete trace learn tutor onboarding" } }, "/v1/trace-learn/parent/children": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.listTraceLearnParentChildren", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "homeworkDueCount", "lastActiveAt", "predictedPassProbability", "credential", "link" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "homeworkDueCount": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind", "lastRotatedAt" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] }, "lastRotatedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false }, "link": { "type": "object", "required": [ "id", "parentId", "relationship", "state" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "parentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "relationship": { "type": "string", "enum": [ "primary_parent", "secondary_parent" ] }, "state": { "type": "string", "enum": [ "active", "pending", "revoked" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.listTraceLearnParentChildren()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.list_trace_learn_parent_children()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn list-trace-learn-parent-children" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/children\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/children';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "List trace learn parent children", "x-displayName": "List trace learn parent children" }, "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.createTraceLearnParentChild", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "homeworkDueCount", "lastActiveAt", "predictedPassProbability", "credential", "link" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "homeworkDueCount": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind", "lastRotatedAt", "temporaryPin" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] }, "lastRotatedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "temporaryPin": { "type": "string", "description": "a string at most 4 character(s) long", "title": "maxLength(4)", "minLength": 4, "maxLength": 4 } }, "additionalProperties": false }, "link": { "type": "object", "required": [ "id", "parentId", "relationship", "state" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "parentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "relationship": { "type": "string", "enum": [ "primary_parent", "secondary_parent" ] }, "state": { "type": "string", "enum": [ "active", "pending", "revoked" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName", "yearGroup", "avatarId" ], "properties": { "displayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "maxLength": 160 }, { "type": "null" } ] }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.createTraceLearnParentChild({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.create_trace_learn_parent_child(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn create-trace-learn-parent-child \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/children\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/children';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create trace learn parent child", "x-displayName": "Create trace learn parent child" } }, "/v1/trace-learn/parent/children/{studentId}": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnParentChildDetail", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "child", "subjects", "topicMastery", "outcomeTrend", "assignments", "projectionFreshness" ], "properties": { "child": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "homeworkDueCount", "lastActiveAt", "predictedPassProbability", "credential", "link" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "homeworkDueCount": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind", "lastRotatedAt" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] }, "lastRotatedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false }, "link": { "type": "object", "required": [ "id", "parentId", "relationship", "state" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "parentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "relationship": { "type": "string", "enum": [ "primary_parent", "secondary_parent" ] }, "state": { "type": "string", "enum": [ "active", "pending", "revoked" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "subjects": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "icon", "score", "questionsCompleted", "totalQuestions", "trend" ], "properties": { "id": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "icon": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "questionsCompleted": { "type": "number" }, "totalQuestions": { "type": "number" }, "trend": { "type": "string", "enum": [ "up", "down", "stable" ] } }, "additionalProperties": false } }, "topicMastery": { "type": "array", "items": { "type": "object", "required": [ "id", "subjectId", "name", "score", "status" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "outcomeTrend": { "type": "array", "items": { "type": "object", "required": [ "capturedAt", "mockExamScore", "predictedPassProbability", "topicsMastered", "timeStudiedMinutes" ], "properties": { "capturedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "mockExamScore": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "topicsMastered": { "type": "number" }, "timeStudiedMinutes": { "type": "number" } }, "additionalProperties": false } }, "assignments": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnParentChildDetail({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_parent_child_detail(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-parent-child-detail \\\n --request '{\"path\":{\"studentId\":\"studentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/children/{}\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/children/$studentId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn parent child detail", "x-displayName": "Trace learn parent child detail" }, "patch": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.updateTraceLearnParentChild", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "homeworkDueCount", "lastActiveAt", "predictedPassProbability", "credential", "link" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "homeworkDueCount": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "credential": { "type": "object", "required": [ "username", "pinSet", "credentialKind", "lastRotatedAt" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "credentialKind": { "type": "string", "enum": [ "student_username_pin" ] }, "lastRotatedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false }, "link": { "type": "object", "required": [ "id", "parentId", "relationship", "state" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "parentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "relationship": { "type": "string", "enum": [ "primary_parent", "secondary_parent" ] }, "state": { "type": "string", "enum": [ "active", "pending", "revoked" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "displayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "maxLength": 160 }, { "type": "null" } ] }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.updateTraceLearnParentChild({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.update_trace_learn_parent_child(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn update-trace-learn-parent-child \\\n --request '{\"path\":{\"studentId\":\"studentId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/children/{}\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/children/$studentId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update trace learn parent child", "x-displayName": "Update trace learn parent child" } }, "/v1/trace-learn/parent/children/{studentId}/tutor-invites": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.inviteTraceLearnTutorForChild", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "inviteId", "studentId", "tutorEmail", "state", "message", "createdAt" ], "properties": { "inviteId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "tutorEmail": { "type": "string" }, "state": { "type": "string", "enum": [ "invited", "already_connected" ] }, "message": { "type": "string" }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tutorEmail" ], "properties": { "tutorEmail": { "type": "string", "description": "a string at most 254 character(s) long", "title": "maxLength(254)", "minLength": 3, "maxLength": 254 }, "note": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.inviteTraceLearnTutorForChild({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.invite_trace_learn_tutor_for_child(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn invite-trace-learn-tutor-for-child \\\n --request '{\"path\":{\"studentId\":\"studentId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/children/{}/tutor-invites\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/children/$studentId/tutor-invites';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Invite trace learn tutor for child", "x-displayName": "Invite trace learn tutor for child" } }, "/v1/trace-learn/parent/dashboard": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnParentDashboard", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "parent", "children", "reports", "projectionFreshness" ], "properties": { "parent": { "type": "object", "required": [ "id", "displayName" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" } }, "additionalProperties": false }, "children": { "type": "array", "items": { "type": "object", "required": [ "id", "displayName", "avatarId", "targetSchool", "overallScore", "homeworkDueCount", "lastActiveAt", "streakDays", "predictedPassProbability" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "homeworkDueCount": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "streakDays": { "type": "number" }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } }, "reports": { "type": "array", "items": { "type": "object", "required": [ "id", "studentId", "title", "periodStart", "periodEnd", "generatedAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "periodStart": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "periodEnd": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "generatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnParentDashboard()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_parent_dashboard()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-parent-dashboard" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/dashboard\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/dashboard';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn parent dashboard", "x-displayName": "Trace learn parent dashboard" } }, "/v1/trace-learn/parent/reports/{reportId}": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnParentReport", "parameters": [ { "name": "reportId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "student", "title", "periodStart", "periodEnd", "generatedAt", "tutorName", "reviewState", "predictedPassProbability", "timeStudiedSeconds", "improvements", "topicMastery", "narrative", "actionItems", "projectionFreshness" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "student": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "title": { "type": "string" }, "periodStart": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "periodEnd": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "generatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "tutorName": { "type": "string" }, "reviewState": { "type": "string", "enum": [ "ready_to_share", "tutor_review_required" ] }, "predictedPassProbability": { "type": "number", "description": "a number between 0 and 1", "title": "between(0, 1)", "minimum": 0, "maximum": 1 }, "timeStudiedSeconds": { "type": "number" }, "improvements": { "type": "array", "items": { "type": "object", "required": [ "metric", "before", "after", "delta" ], "properties": { "metric": { "type": "string" }, "before": { "type": "string" }, "after": { "type": "string" }, "delta": { "type": "string" } }, "additionalProperties": false } }, "topicMastery": { "type": "array", "items": { "type": "object", "required": [ "id", "subjectId", "name", "score", "status" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "narrative": { "type": "object", "required": [ "positive", "causeHypothesis", "systemResponse" ], "properties": { "positive": { "type": "string" }, "causeHypothesis": { "type": "string" }, "systemResponse": { "type": "string" } }, "additionalProperties": false }, "actionItems": { "type": "array", "items": { "type": "string" } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnParentReport({\n reportId: process.env.TX_AGENT_KIT_REPORT_ID ?? \"reportId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_parent_report(\n reportId=os.environ.get(\"TX_AGENT_KIT_REPORT_ID\", \"reportId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-parent-report \\\n --request '{\"path\":{\"reportId\":\"reportId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let report_id = env::var(\"TX_AGENT_KIT_REPORT_ID\").unwrap_or_else(|_| \"reportId\".to_string());\n let url = format!(\"{}/v1/trace-learn/parent/reports/{}\", base_url.trim_end_matches('/'), report_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final reportId = Platform.environment['TX_AGENT_KIT_REPORT_ID'] ?? 'reportId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/parent/reports/$reportId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn parent report", "x-displayName": "Trace learn parent report" } }, "/v1/trace-learn/policy/decisions/latest": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnPolicyDecisionLog", "parameters": [ { "name": "studentId", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "studentId", "learnerKey", "questionId", "questionVersionId", "attemptId", "selectedCandidateId", "actionType", "algorithmId", "algorithmVersion", "propensity", "candidates", "studentState", "constraints", "reasonCodes", "candidateScores", "projectionFreshness", "sessionId", "sessionType", "positionInSession", "createdAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "learnerKey": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "questionVersionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "attemptId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "selectedCandidateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "actionType": { "type": "string", "enum": [ "lesson", "mini-test", "test", "practice", "break" ] }, "algorithmId": { "type": "string", "enum": [ "mastery_policy_v0", "projection_fallback_v0", "offline_replay" ] }, "algorithmVersion": { "type": "string" }, "propensity": { "type": "number" }, "candidates": { "type": "array", "items": { "type": "object", "required": [ "candidateId", "actionType", "targetId", "label", "eligible", "reasonCodes", "source" ], "properties": { "candidateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "actionType": { "type": "string", "enum": [ "lesson", "mini-test", "test", "practice", "break" ] }, "targetId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" }, "eligible": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string", "enum": [ "due_review", "weak_subdomain", "exam_priority", "prerequisite", "mixed_review_ready", "confidence_recovery", "fatigue_guardrail", "blueprint_bucket", "tutor_assigned", "diagnostic", "projection_fallback", "content_fallback", "not_enough_evidence", "excluded_by_constraint", "ineligible_missing_content", "ineligible_wrong_answer_mode" ] } }, "source": { "type": "string", "enum": [ "assignment", "adaptive", "diagnostic", "fallback" ] } }, "additionalProperties": false } }, "studentState": { "type": "object", "required": [ "studentId", "learnerKey", "fatigueLevel", "speedRegime", "consecutiveCorrect", "activeAssignmentId", "masteryByTopic" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "learnerKey": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "fatigueLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "speedRegime": { "type": "string", "enum": [ "slow", "steady", "fast" ] }, "consecutiveCorrect": { "type": "number" }, "activeAssignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "masteryByTopic": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "topicId", "status", "score", "lastPractisedAt" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] }, "score": { "type": "number" }, "lastPractisedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "constraints": { "type": "object", "required": [ "allowedActionTypes", "excludedCandidateIds", "contentAvailable", "maxDifficulty", "requirePublishedContent" ], "properties": { "allowedActionTypes": { "type": "array", "items": { "type": "string", "enum": [ "lesson", "mini-test", "test", "practice", "break" ] } }, "excludedCandidateIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "contentAvailable": { "type": "boolean" }, "maxDifficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "requirePublishedContent": { "type": "boolean" } }, "additionalProperties": false }, "reasonCodes": { "type": "array", "items": { "type": "string", "enum": [ "due_review", "weak_subdomain", "exam_priority", "prerequisite", "mixed_review_ready", "confidence_recovery", "fatigue_guardrail", "blueprint_bucket", "tutor_assigned", "diagnostic", "projection_fallback", "content_fallback", "not_enough_evidence", "excluded_by_constraint", "ineligible_missing_content", "ineligible_wrong_answer_mode" ] } }, "candidateScores": { "type": "array", "items": { "type": "object", "required": [ "candidateId", "score", "reasonCodes", "scoreBreakdown" ], "properties": { "candidateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "score": { "type": "number" }, "reasonCodes": { "type": "array", "items": { "type": "string", "enum": [ "due_review", "weak_subdomain", "exam_priority", "prerequisite", "mixed_review_ready", "confidence_recovery", "fatigue_guardrail", "blueprint_bucket", "tutor_assigned", "diagnostic", "projection_fallback", "content_fallback", "not_enough_evidence", "excluded_by_constraint", "ineligible_missing_content", "ineligible_wrong_answer_mode" ] } }, "scoreBreakdown": { "type": "array", "items": { "type": "object", "required": [ "factor", "value" ], "properties": { "factor": { "type": "string", "enum": [ "mastery_gap", "retention_due", "exam_weight", "difficulty_fit", "fatigue_penalty", "confidence_recovery", "blueprint_fit", "fallback_priority" ] }, "value": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection", "fallback" ] } }, "additionalProperties": false }, "sessionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "sessionType": { "type": "string", "enum": [ "diagnostic", "lesson", "mini-test", "test", "practice" ] }, "positionInSession": { "type": "number" }, "createdAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnPolicyDecisionLog({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_policy_decision_log()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-policy-decision-log" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/policy/decisions/latest\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/policy/decisions/latest';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn policy decision log", "x-displayName": "Trace learn policy decision log" } }, "/v1/trace-learn/policy/next-action": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.traceLearnPolicyNextAction", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "decisionId", "type", "targetId", "label", "reason", "projectionFreshness" ], "properties": { "decisionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "lesson", "mini-test", "test", "practice", "break" ] }, "targetId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" }, "reason": { "type": "string" }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "studentId", "origin" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "origin": { "type": "string", "enum": [ "dashboard", "learn_complete", "homework_complete", "diagnostic_complete" ] }, "completedActionId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.traceLearnPolicyNextAction({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.trace_learn_policy_next_action(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn trace-learn-policy-next-action \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/policy/next-action\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/policy/next-action';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Trace learn policy next action", "x-displayName": "Trace learn policy next action" } }, "/v1/trace-learn/policy/replay": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.traceLearnReplayPolicyDecision", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "decisionLogId", "originalAlgorithmId", "candidateAlgorithmId", "originalSelectedCandidateId", "replayedSelectedCandidateId", "changed", "reason", "replayedAt" ], "properties": { "decisionLogId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "originalAlgorithmId": { "type": "string", "enum": [ "mastery_policy_v0", "projection_fallback_v0", "offline_replay" ] }, "candidateAlgorithmId": { "type": "string", "enum": [ "mastery_policy_v0", "projection_fallback_v0", "offline_replay" ] }, "originalSelectedCandidateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "replayedSelectedCandidateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "changed": { "type": "boolean" }, "reason": { "type": "string" }, "replayedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "decisionLogId", "candidateAlgorithmId", "dryRun" ], "properties": { "decisionLogId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "candidateAlgorithmId": { "type": "string", "enum": [ "mastery_policy_v0", "projection_fallback_v0", "offline_replay" ] }, "dryRun": { "type": "boolean", "enum": [ true ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.traceLearnReplayPolicyDecision({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.trace_learn_replay_policy_decision(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn trace-learn-replay-policy-decision \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/policy/replay\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/policy/replay';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Trace learn replay policy decision", "x-displayName": "Trace learn replay policy decision" } }, "/v1/trace-learn/privacy/retention": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnPrivacyRetention", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "generatedAt", "learnerKeyRule", "localSpillDefaults", "retentionPolicies", "piiGuards", "retentionCleanerIntegration" ], "properties": { "generatedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "learnerKeyRule": { "type": "string" }, "localSpillDefaults": { "type": "object", "required": [ "personalDeviceTtlDays", "sharedDeviceTtlDays", "sharedDeviceMaxSessions" ], "properties": { "personalDeviceTtlDays": { "type": "number" }, "sharedDeviceTtlDays": { "type": "number" }, "sharedDeviceMaxSessions": { "type": "number" } }, "additionalProperties": false }, "retentionPolicies": { "type": "array", "items": { "type": "object", "required": [ "id", "dataClass", "label", "owningDomain", "storeKind", "defaultRetentionDays", "hardTtlDays", "action", "pseudonymous", "containsChildPii", "retentionTableName", "liveInV1", "notes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "dataClass": { "type": "string", "enum": [ "child_identity", "learning_telemetry_raw", "learning_session_rollup", "operational_learning_record", "decision_log", "ephemeral_processing_artifact", "content_provenance_audit", "notification_delivery_log", "financial_audit" ] }, "label": { "type": "string" }, "owningDomain": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "storeKind": { "type": "string", "enum": [ "existing_retention_cleaner", "client_spill_queue", "domain_soft_delete", "audit_exempt", "future_extension" ] }, "defaultRetentionDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hardTtlDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "action": { "type": "string", "enum": [ "prune", "roll_up_then_prune", "soft_delete", "delete_on_commit_or_ttl", "retain_audit", "deidentify" ] }, "pseudonymous": { "type": "boolean" }, "containsChildPii": { "type": "boolean" }, "retentionTableName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "liveInV1": { "type": "boolean" }, "notes": { "type": "string" } }, "additionalProperties": false } }, "piiGuards": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "status", "detail" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "implemented", "specified", "pending_schema" ] }, "detail": { "type": "string" } }, "additionalProperties": false } }, "retentionCleanerIntegration": { "type": "object", "required": [ "registeredTableNames", "pendingTableNames", "excludedFinancialAuditTables" ], "properties": { "registeredTableNames": { "type": "array", "items": { "type": "string" } }, "pendingTableNames": { "type": "array", "items": { "type": "string" } }, "excludedFinancialAuditTables": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnPrivacyRetention()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_privacy_retention()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-privacy-retention" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/privacy/retention\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/privacy/retention';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn privacy retention", "x-displayName": "Trace learn privacy retention" } }, "/v1/trace-learn/results/{resultId}": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnResult", "parameters": [ { "name": "resultId", "in": "path", "schema": { "$ref": "#/components/schemas/UUID" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "studentId", "assignmentId", "assignmentTitle", "assignmentType", "submittedAt", "scorePercent", "correctCount", "questionCount", "timeTakenSeconds", "passed", "topicBreakdown", "mistakes", "remediation", "rewardDelta" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentTitle": { "type": "string" }, "assignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "submittedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "timeTakenSeconds": { "type": "number" }, "passed": { "type": "boolean" }, "topicBreakdown": { "type": "array", "items": { "type": "object", "required": [ "topicId", "topicName", "subjectId", "scorePercent", "correctCount", "questionCount", "status" ], "properties": { "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "mistakes": { "type": "array", "items": { "type": "object", "required": [ "questionId", "prompt", "selectedAnswerLabel", "correctAnswerLabel", "explanation", "topicName" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "selectedAnswerLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "correctAnswerLabel": { "type": "string" }, "explanation": { "type": "string" }, "topicName": { "type": "string" } }, "additionalProperties": false } }, "remediation": { "type": "object", "required": [ "nextLessonSegmentId", "nextLessonTitle", "practiceAssignmentId", "practiceAssignmentType", "focusTopicIds" ], "properties": { "nextLessonSegmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "nextLessonTitle": { "type": "string" }, "practiceAssignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "practiceAssignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "focusTopicIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "rewardDelta": { "type": "object", "required": [ "starsEarned", "gameSecondsEarned", "streakDays", "unlockedGameIds" ], "properties": { "starsEarned": { "type": "number" }, "gameSecondsEarned": { "type": "number" }, "streakDays": { "type": "number" }, "unlockedGameIds": { "type": "array", "items": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnResult({\n resultId: process.env.TX_AGENT_KIT_RESULT_ID ?? \"resultId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_result(\n resultId=os.environ.get(\"TX_AGENT_KIT_RESULT_ID\", \"resultId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-result \\\n --request '{\"path\":{\"resultId\":\"resultId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let result_id = env::var(\"TX_AGENT_KIT_RESULT_ID\").unwrap_or_else(|_| \"resultId\".to_string());\n let url = format!(\"{}/v1/trace-learn/results/{}\", base_url.trim_end_matches('/'), result_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final resultId = Platform.environment['TX_AGENT_KIT_RESULT_ID'] ?? 'resultId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/results/$resultId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn result", "x-displayName": "Trace learn result" } }, "/v1/trace-learn/results/latest": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnLatestResult", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "studentId", "assignmentId", "assignmentTitle", "assignmentType", "submittedAt", "scorePercent", "correctCount", "questionCount", "timeTakenSeconds", "passed", "topicBreakdown", "mistakes", "remediation", "rewardDelta" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentTitle": { "type": "string" }, "assignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "submittedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "timeTakenSeconds": { "type": "number" }, "passed": { "type": "boolean" }, "topicBreakdown": { "type": "array", "items": { "type": "object", "required": [ "topicId", "topicName", "subjectId", "scorePercent", "correctCount", "questionCount", "status" ], "properties": { "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "correctCount": { "type": "number" }, "questionCount": { "type": "number" }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "mistakes": { "type": "array", "items": { "type": "object", "required": [ "questionId", "prompt", "selectedAnswerLabel", "correctAnswerLabel", "explanation", "topicName" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "selectedAnswerLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "correctAnswerLabel": { "type": "string" }, "explanation": { "type": "string" }, "topicName": { "type": "string" } }, "additionalProperties": false } }, "remediation": { "type": "object", "required": [ "nextLessonSegmentId", "nextLessonTitle", "practiceAssignmentId", "practiceAssignmentType", "focusTopicIds" ], "properties": { "nextLessonSegmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "nextLessonTitle": { "type": "string" }, "practiceAssignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "practiceAssignmentType": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "focusTopicIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "rewardDelta": { "type": "object", "required": [ "starsEarned", "gameSecondsEarned", "streakDays", "unlockedGameIds" ], "properties": { "starsEarned": { "type": "number" }, "gameSecondsEarned": { "type": "number" }, "streakDays": { "type": "number" }, "unlockedGameIds": { "type": "array", "items": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnLatestResult()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_latest_result()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-latest-result" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/results/latest\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/results/latest';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn latest result", "x-displayName": "Trace learn latest result" } }, "/v1/trace-learn/rewards/games": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnGameBank", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "studentId", "rewardState", "games", "recentUnlocks", "wellbeing" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "rewardState": { "type": "object", "required": [ "streakDays", "starsEarned", "earnedSeconds", "spentSeconds", "availableSeconds", "dailyCapSeconds" ], "properties": { "streakDays": { "type": "number" }, "starsEarned": { "type": "number" }, "earnedSeconds": { "type": "number" }, "spentSeconds": { "type": "number" }, "availableSeconds": { "type": "number" }, "dailyCapSeconds": { "type": "number" } }, "additionalProperties": false }, "games": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "description", "status", "unlocked", "isNew", "unlockTopic" ], "properties": { "id": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "live", "coming_soon" ] }, "unlocked": { "type": "boolean" }, "isNew": { "type": "boolean" }, "unlockTopic": { "type": "string" } }, "additionalProperties": false } }, "recentUnlocks": { "type": "array", "items": { "type": "object", "required": [ "gameId", "unlockedAt", "reason" ], "properties": { "gameId": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "unlockedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "reason": { "type": "string" } }, "additionalProperties": false } }, "wellbeing": { "type": "object", "required": [ "breakRecommended", "fatigueLevel", "dailyCapSeconds", "nextBreakAtSeconds" ], "properties": { "breakRecommended": { "type": "boolean" }, "fatigueLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "dailyCapSeconds": { "type": "number" }, "nextBreakAtSeconds": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnGameBank()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_game_bank()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-game-bank" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/rewards/games\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/rewards/games';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn game bank", "x-displayName": "Trace learn game bank" } }, "/v1/trace-learn/rewards/games/spend": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.recordTraceLearnGameTimeSpend", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "studentId", "rewardState", "games", "recentUnlocks", "wellbeing" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "rewardState": { "type": "object", "required": [ "streakDays", "starsEarned", "earnedSeconds", "spentSeconds", "availableSeconds", "dailyCapSeconds" ], "properties": { "streakDays": { "type": "number" }, "starsEarned": { "type": "number" }, "earnedSeconds": { "type": "number" }, "spentSeconds": { "type": "number" }, "availableSeconds": { "type": "number" }, "dailyCapSeconds": { "type": "number" } }, "additionalProperties": false }, "games": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "description", "status", "unlocked", "isNew", "unlockTopic" ], "properties": { "id": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "live", "coming_soon" ] }, "unlocked": { "type": "boolean" }, "isNew": { "type": "boolean" }, "unlockTopic": { "type": "string" } }, "additionalProperties": false } }, "recentUnlocks": { "type": "array", "items": { "type": "object", "required": [ "gameId", "unlockedAt", "reason" ], "properties": { "gameId": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "unlockedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "reason": { "type": "string" } }, "additionalProperties": false } }, "wellbeing": { "type": "object", "required": [ "breakRecommended", "fatigueLevel", "dailyCapSeconds", "nextBreakAtSeconds" ], "properties": { "breakRecommended": { "type": "boolean" }, "fatigueLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "dailyCapSeconds": { "type": "number" }, "nextBreakAtSeconds": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "gameId", "secondsSpent" ], "properties": { "gameId": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "secondsSpent": { "type": "integer", "description": "a number between 1 and 3600", "title": "between(1, 3600)", "minimum": 1, "maximum": 3600 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.recordTraceLearnGameTimeSpend({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.record_trace_learn_game_time_spend(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn record-trace-learn-game-time-spend \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/rewards/games/spend\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/rewards/games/spend';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Record trace learn game time spend", "x-displayName": "Record trace learn game time spend" } }, "/v1/trace-learn/routes": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnRoutes", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "path", "owner", "layout", "authRequired", "navGroup", "devOnly", "deepLinkable" ], "properties": { "path": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "owner": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal", "public" ] }, "layout": { "type": "string", "enum": [ "portal", "immersive" ] }, "authRequired": { "type": "boolean" }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devOnly": { "type": "boolean" }, "deepLinkable": { "type": "boolean" } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnRoutes()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_routes()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-routes" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/routes\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/routes';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn routes", "x-displayName": "Trace learn routes" } }, "/v1/trace-learn/session/context": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnSessionContext", "parameters": [ { "name": "role", "in": "query", "schema": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "actorId", "role", "displayName", "organizationId", "teamId", "studentId", "learnerKey", "entitlementState", "adminGrants" ], "properties": { "actorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "role": { "type": "string", "enum": [ "student", "tutor", "parent", "admin_internal" ] }, "displayName": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "organizationId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "teamId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "learnerKey": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "adminGrants": { "type": "array", "items": { "type": "string", "enum": [ "content_admin", "platform_admin", "support" ] } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnSessionContext({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_session_context()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-session-context" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/session/context\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/session/context';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn session context", "x-displayName": "Trace learn session context" } }, "/v1/trace-learn/settings": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnSettings", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile", "learning", "notifications", "reporting", "billing" ], "properties": { "profile": { "type": "object", "required": [ "displayName", "yearGroup", "targetSchool", "defaultExamBoard" ], "properties": { "displayName": { "type": "string" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "defaultExamBoard": { "type": "string", "enum": [ "GL Assessment", "CEM", "ISEB", "Mixed" ] } }, "additionalProperties": false }, "learning": { "type": "object", "required": [ "soundEffects", "streakReminders", "reducedMotion", "highContrast" ], "properties": { "soundEffects": { "type": "boolean" }, "streakReminders": { "type": "boolean" }, "reducedMotion": { "type": "boolean" }, "highContrast": { "type": "boolean" } }, "additionalProperties": false }, "notifications": { "type": "object", "required": [ "homeworkReminders", "completionEmails", "weeklyParentDigest", "quietHoursStart", "quietHoursEnd" ], "properties": { "homeworkReminders": { "type": "boolean" }, "completionEmails": { "type": "boolean" }, "weeklyParentDigest": { "type": "boolean" }, "quietHoursStart": { "type": "string" }, "quietHoursEnd": { "type": "string" } }, "additionalProperties": false }, "reporting": { "type": "object", "required": [ "parentReportFrequency", "autoSendReportsToParents", "requireTutorReviewBeforeShare" ], "properties": { "parentReportFrequency": { "type": "string", "enum": [ "weekly", "fortnightly", "monthly", "off" ] }, "autoSendReportsToParents": { "type": "boolean" }, "requireTutorReviewBeforeShare": { "type": "boolean" } }, "additionalProperties": false }, "billing": { "type": "object", "required": [ "entitlementState", "planLabel", "learnerLimit" ], "properties": { "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "planLabel": { "type": "string" }, "learnerLimit": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnSettings()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_settings()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-settings" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/settings\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/settings';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn settings", "x-displayName": "Trace learn settings" }, "patch": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.updateTraceLearnSettings", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile", "learning", "notifications", "reporting", "billing" ], "properties": { "profile": { "type": "object", "required": [ "displayName", "yearGroup", "targetSchool", "defaultExamBoard" ], "properties": { "displayName": { "type": "string" }, "email": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "defaultExamBoard": { "type": "string", "enum": [ "GL Assessment", "CEM", "ISEB", "Mixed" ] } }, "additionalProperties": false }, "learning": { "type": "object", "required": [ "soundEffects", "streakReminders", "reducedMotion", "highContrast" ], "properties": { "soundEffects": { "type": "boolean" }, "streakReminders": { "type": "boolean" }, "reducedMotion": { "type": "boolean" }, "highContrast": { "type": "boolean" } }, "additionalProperties": false }, "notifications": { "type": "object", "required": [ "homeworkReminders", "completionEmails", "weeklyParentDigest", "quietHoursStart", "quietHoursEnd" ], "properties": { "homeworkReminders": { "type": "boolean" }, "completionEmails": { "type": "boolean" }, "weeklyParentDigest": { "type": "boolean" }, "quietHoursStart": { "type": "string" }, "quietHoursEnd": { "type": "string" } }, "additionalProperties": false }, "reporting": { "type": "object", "required": [ "parentReportFrequency", "autoSendReportsToParents", "requireTutorReviewBeforeShare" ], "properties": { "parentReportFrequency": { "type": "string", "enum": [ "weekly", "fortnightly", "monthly", "off" ] }, "autoSendReportsToParents": { "type": "boolean" }, "requireTutorReviewBeforeShare": { "type": "boolean" } }, "additionalProperties": false }, "billing": { "type": "object", "required": [ "entitlementState", "planLabel", "learnerLimit" ], "properties": { "entitlementState": { "type": "string", "enum": [ "diagnostic_only", "trial", "active", "past_due", "none" ] }, "planLabel": { "type": "string" }, "learnerLimit": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "learning": { "type": "object", "required": [], "properties": { "soundEffects": { "type": "boolean" }, "streakReminders": { "type": "boolean" }, "reducedMotion": { "type": "boolean" }, "highContrast": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.updateTraceLearnSettings({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.update_trace_learn_settings(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn update-trace-learn-settings \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/settings\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.patch(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/settings';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.patch(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Update trace learn settings", "x-displayName": "Update trace learn settings" } }, "/v1/trace-learn/students/me/dashboard": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnStudentDashboard", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "student", "overallScore", "streakDays", "homework", "subjects", "weakTopics", "strongTopics", "recentActivity", "analyticsProgress", "rewardState", "games", "projectionFreshness" ], "properties": { "student": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "streakDays": { "type": "number" }, "homework": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false } }, "subjects": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "icon", "score", "questionsCompleted", "totalQuestions", "trend" ], "properties": { "id": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "icon": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "questionsCompleted": { "type": "number" }, "totalQuestions": { "type": "number" }, "trend": { "type": "string", "enum": [ "up", "down", "stable" ] } }, "additionalProperties": false } }, "weakTopics": { "type": "array", "items": { "type": "object", "required": [ "id", "subjectId", "name", "score", "status" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "strongTopics": { "type": "array", "items": { "type": "object", "required": [ "id", "subjectId", "name", "score", "status" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "status": { "type": "string", "enum": [ "mastered", "learning", "needs-work", "not-started" ] } }, "additionalProperties": false } }, "recentActivity": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "title", "subjectId", "subjectName", "score", "durationSeconds", "occurredAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "enum": [ "lesson", "quiz", "test", "practice" ] }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "score": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "durationSeconds": { "type": "number" }, "occurredAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } }, "analyticsProgress": { "type": "object", "required": [ "weekly", "daily" ], "properties": { "weekly": { "type": "array", "items": { "type": "object", "required": [ "label", "score", "questions" ], "properties": { "label": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "questions": { "type": "number" } }, "additionalProperties": false } }, "daily": { "type": "array", "items": { "type": "object", "required": [ "date", "label", "score", "questions" ], "properties": { "date": { "type": "string" }, "label": { "type": "string" }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "questions": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "rewardState": { "type": "object", "required": [ "streakDays", "starsEarned", "earnedSeconds", "spentSeconds", "availableSeconds", "dailyCapSeconds" ], "properties": { "streakDays": { "type": "number" }, "starsEarned": { "type": "number" }, "earnedSeconds": { "type": "number" }, "spentSeconds": { "type": "number" }, "availableSeconds": { "type": "number" }, "dailyCapSeconds": { "type": "number" } }, "additionalProperties": false }, "games": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "description", "status", "unlocked", "isNew", "unlockTopic" ], "properties": { "id": { "type": "string", "enum": [ "tic-tac-toe", "word-search", "speed-maths", "pattern-match", "spelling-bee", "code-breaker", "shape-fold", "word-chains", "number-ninja" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "live", "coming_soon" ] }, "unlocked": { "type": "boolean" }, "isNew": { "type": "boolean" }, "unlockTopic": { "type": "string" } }, "additionalProperties": false } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnStudentDashboard()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_student_dashboard()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-student-dashboard" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/students/me/dashboard\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/students/me/dashboard';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn student dashboard", "x-displayName": "Trace learn student dashboard" } }, "/v1/trace-learn/tutor/analytics": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnTutorAnalytics", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "tutorId", "dateRange", "cohortSize", "averageAccuracy", "averageTimePerQuestionSeconds", "subjectAverages", "weakTopicDistribution", "studentEngagement", "recentSubmissions", "projectionFreshness" ], "properties": { "tutorId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "dateRange": { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "end": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false }, "cohortSize": { "type": "number" }, "averageAccuracy": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "averageTimePerQuestionSeconds": { "type": "number" }, "subjectAverages": { "type": "array", "items": { "type": "object", "required": [ "subjectId", "score", "questionsCompleted" ], "properties": { "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "score": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "questionsCompleted": { "type": "number" } }, "additionalProperties": false } }, "weakTopicDistribution": { "type": "array", "items": { "type": "object", "required": [ "topicId", "topicName", "weakStudentCount" ], "properties": { "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "weakStudentCount": { "type": "number" } }, "additionalProperties": false } }, "studentEngagement": { "type": "array", "items": { "type": "object", "required": [ "studentId", "displayName", "activeMinutes", "assignmentsCompleted", "latestScore" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "activeMinutes": { "type": "number" }, "assignmentsCompleted": { "type": "number" }, "latestScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } }, "recentSubmissions": { "type": "array", "items": { "type": "object", "required": [ "resultId", "studentId", "assignmentId", "studentName", "assignmentTitle", "scorePercent", "submittedAt" ], "properties": { "resultId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "assignmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "studentName": { "type": "string" }, "assignmentTitle": { "type": "string" }, "scorePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "submittedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnTutorAnalytics()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_tutor_analytics()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-tutor-analytics" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/analytics\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/analytics';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn tutor analytics", "x-displayName": "Trace learn tutor analytics" } }, "/v1/trace-learn/tutor/assignments": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.createTraceLearnTutorAssignment", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignment", "audience", "timing", "publication" ], "properties": { "assignment": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "audience": { "type": "object", "required": [ "studentIds", "label" ], "properties": { "studentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "label": { "type": "string" } }, "additionalProperties": false }, "timing": { "type": "object", "required": [ "totalSeconds", "allowPause", "showTimeRemaining", "immediateFeedback", "retryPolicy" ], "properties": { "totalSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "allowPause": { "type": "boolean" }, "showTimeRemaining": { "type": "boolean" }, "immediateFeedback": { "type": "boolean" }, "retryPolicy": { "type": "string", "enum": [ "retry-in-place", "reassign-required" ] } }, "additionalProperties": false }, "publication": { "type": "object", "required": [ "state", "createdStudentAssignmentIds", "contentFrozen", "blueprintStatus" ], "properties": { "state": { "type": "string", "enum": [ "draft", "assigned" ] }, "createdStudentAssignmentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "contentFrozen": { "type": "boolean" }, "blueprintStatus": { "type": "string", "enum": [ "validated", "practice_mix_only" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "type", "subjectIds", "questionCount", "timeLimitMinutes", "dueAt", "assigneeStudentIds", "publishImmediately" ], "properties": { "title": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "subjectIds": { "type": "array", "items": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] } }, "questionCount": { "type": "number" }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "assigneeStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "publishImmediately": { "type": "boolean" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.createTraceLearnTutorAssignment({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.create_trace_learn_tutor_assignment(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn create-trace-learn-tutor-assignment \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/assignments\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/assignments';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create trace learn tutor assignment", "x-displayName": "Create trace learn tutor assignment" } }, "/v1/trace-learn/tutor/assignments/{assignmentId}": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnTutorAssignmentDetail", "parameters": [ { "name": "assignmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignment", "summary", "targetStudents", "attempts", "questions", "reviewState", "projectionFreshness" ], "properties": { "assignment": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false }, "summary": { "type": "object", "required": [ "assignedCount", "completedCount", "completionRatePercent", "classAveragePercent", "averageTimeSeconds", "flaggedQuestionCount" ], "properties": { "assignedCount": { "type": "number" }, "completedCount": { "type": "number" }, "completionRatePercent": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "classAveragePercent": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "averageTimeSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "flaggedQuestionCount": { "type": "number" } }, "additionalProperties": false }, "targetStudents": { "type": "array", "items": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } }, "attempts": { "type": "array", "items": { "type": "object", "required": [ "attemptId", "studentId", "studentName", "avatarId", "state", "startedAt", "submittedAt", "scorePercent", "correctCount", "questionCount", "totalTimeSeconds", "questionAttempts" ], "properties": { "attemptId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "not-started", "in-progress", "submitted", "reviewed", "abandoned" ] }, "startedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "submittedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "scorePercent": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "correctCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "questionCount": { "type": "number" }, "totalTimeSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "questionAttempts": { "type": "array", "items": { "type": "object", "required": [ "questionId", "state", "selectedAnswerIndex", "selectedAnswerLabel", "correctAnswerIndex", "correctAnswerLabel", "isCorrect", "timeSeconds", "flagged" ], "properties": { "questionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "answered", "skipped" ] }, "selectedAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "selectedAnswerLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "correctAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "correctAnswerLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isCorrect": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "timeSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "flagged": { "type": "boolean" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "questions": { "type": "array", "items": { "type": "object", "required": [ "order", "question", "redHerring" ], "properties": { "order": { "type": "number" }, "question": { "type": "object", "required": [ "id", "questionVersionId", "subjectId", "subjectName", "topicId", "topicName", "difficulty", "answerKind", "answerMode", "interactionMode", "prompt", "options", "correctAnswerIndex", "explanation", "expectedTimeSeconds" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "questionVersionId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "subjectId": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "subjectName": { "type": "string" }, "topicId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "topicName": { "type": "string" }, "difficulty": { "type": "string", "enum": [ "easy", "medium", "hard" ] }, "answerKind": { "type": "string", "enum": [ "single-select", "multi-select", "text", "numeric", "order", "matching" ] }, "answerMode": { "type": "string", "enum": [ "single_select_mcq", "multi_select_mcq", "text_comprehension_cluster", "cloze_or_gap_fill", "sequence_completion", "matching_or_pairing", "matrix_or_pattern_completion", "short_free_response", "numeric_free_response", "written_composition" ] }, "interactionMode": { "type": "string", "enum": [ "digital_click", "digital_type", "paper_mcq_shading", "handwritten_free_response" ] }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "correctAnswerIndex": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "explanation": { "type": "string" }, "expectedTimeSeconds": { "type": "number" }, "clozeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clozeBlanks": { "type": "array", "items": { "type": "object", "required": [ "id", "options" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "options": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "matchingLeftLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingRightLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchingPairs": { "type": "array", "items": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "string" }, "right": { "type": "string" } }, "additionalProperties": false } }, "sequenceChips": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "label": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "redHerring": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "reviewState": { "type": "object", "required": [ "status", "canPublish", "canSendReminders", "canRequestRedo", "lastReviewedAt" ], "properties": { "status": { "type": "string", "enum": [ "draft", "published", "needs-review", "closed" ] }, "canPublish": { "type": "boolean" }, "canSendReminders": { "type": "boolean" }, "canRequestRedo": { "type": "boolean" }, "lastReviewedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnTutorAssignmentDetail({\n assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? \"assignmentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_tutor_assignment_detail(\n assignmentId=os.environ.get(\"TX_AGENT_KIT_ASSIGNMENT_ID\", \"assignmentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-tutor-assignment-detail \\\n --request '{\"path\":{\"assignmentId\":\"assignmentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let assignment_id = env::var(\"TX_AGENT_KIT_ASSIGNMENT_ID\").unwrap_or_else(|_| \"assignmentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/assignments/{}\", base_url.trim_end_matches('/'), assignment_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final assignmentId = Platform.environment['TX_AGENT_KIT_ASSIGNMENT_ID'] ?? 'assignmentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/assignments/$assignmentId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn tutor assignment detail", "x-displayName": "Trace learn tutor assignment detail" }, "delete": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.deleteTraceLearnTutorAssignment", "parameters": [ { "name": "assignmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.deleteTraceLearnTutorAssignment({\n assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? \"assignmentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.delete_trace_learn_tutor_assignment(\n assignmentId=os.environ.get(\"TX_AGENT_KIT_ASSIGNMENT_ID\", \"assignmentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn delete-trace-learn-tutor-assignment \\\n --request '{\"path\":{\"assignmentId\":\"assignmentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let assignment_id = env::var(\"TX_AGENT_KIT_ASSIGNMENT_ID\").unwrap_or_else(|_| \"assignmentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/assignments/{}\", base_url.trim_end_matches('/'), assignment_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final assignmentId = Platform.environment['TX_AGENT_KIT_ASSIGNMENT_ID'] ?? 'assignmentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/assignments/$assignmentId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete trace learn tutor assignment", "x-displayName": "Delete trace learn tutor assignment" } }, "/v1/trace-learn/tutor/assignments/{assignmentId}/review": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.reviewTraceLearnTutorAssignment", "parameters": [ { "name": "assignmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignmentId", "action", "accepted", "affectedStudentIds", "eventId", "message", "reviewState" ], "properties": { "assignmentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "action": { "type": "string", "enum": [ "mark-reviewed", "publish", "send-reminder", "request-redo" ] }, "accepted": { "type": "boolean" }, "affectedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "eventId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "message": { "type": "string" }, "reviewState": { "type": "object", "required": [ "status", "lastReviewedAt" ], "properties": { "status": { "type": "string", "enum": [ "draft", "published", "needs-review", "closed" ] }, "lastReviewedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "enum": [ "mark-reviewed", "publish", "send-reminder", "request-redo" ] }, "studentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "note": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.reviewTraceLearnTutorAssignment({\n assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? \"assignmentId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.review_trace_learn_tutor_assignment(\n assignmentId=os.environ.get(\"TX_AGENT_KIT_ASSIGNMENT_ID\", \"assignmentId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn review-trace-learn-tutor-assignment \\\n --request '{\"path\":{\"assignmentId\":\"assignmentId\"},\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let assignment_id = env::var(\"TX_AGENT_KIT_ASSIGNMENT_ID\").unwrap_or_else(|_| \"assignmentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/assignments/{}/review\", base_url.trim_end_matches('/'), assignment_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final assignmentId = Platform.environment['TX_AGENT_KIT_ASSIGNMENT_ID'] ?? 'assignmentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/assignments/$assignmentId/review';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Review trace learn tutor assignment", "x-displayName": "Review trace learn tutor assignment" } }, "/v1/trace-learn/tutor/assignments/authoring-options": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnAssignmentAuthoringOptions", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "subjects", "students", "modeRules" ], "properties": { "subjects": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "students": { "type": "array", "items": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } }, "modeRules": { "type": "object", "required": [ "miniTest", "test", "practice" ], "properties": { "miniTest": { "type": "object", "required": [ "defaultQuestionCount", "allowedQuestionCounts", "defaultTimeLimitMinutes", "allowedTimeLimitMinutes", "immediateFeedback" ], "properties": { "defaultQuestionCount": { "type": "number" }, "allowedQuestionCounts": { "type": "array", "items": { "type": "number" } }, "defaultTimeLimitMinutes": { "type": "number" }, "allowedTimeLimitMinutes": { "type": "array", "items": { "type": "number" } }, "immediateFeedback": { "type": "boolean" } }, "additionalProperties": false }, "test": { "type": "object", "required": [ "defaultQuestionCount", "allowedQuestionCounts", "defaultTimeLimitMinutes", "allowedTimeLimitMinutes", "immediateFeedback" ], "properties": { "defaultQuestionCount": { "type": "number" }, "allowedQuestionCounts": { "type": "array", "items": { "type": "number" } }, "defaultTimeLimitMinutes": { "type": "number" }, "allowedTimeLimitMinutes": { "type": "array", "items": { "type": "number" } }, "immediateFeedback": { "type": "boolean" } }, "additionalProperties": false }, "practice": { "type": "object", "required": [ "fixedQuestionCount", "fixedTimeLimitMinutes", "immediateFeedback", "blueprintStatus" ], "properties": { "fixedQuestionCount": { "type": "number" }, "fixedTimeLimitMinutes": { "type": "number" }, "immediateFeedback": { "type": "boolean" }, "blueprintStatus": { "type": "string", "enum": [ "validated", "practice_mix_only" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnAssignmentAuthoringOptions()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_assignment_authoring_options()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-assignment-authoring-options" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/assignments/authoring-options\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/assignments/authoring-options';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn assignment authoring options", "x-displayName": "Trace learn assignment authoring options" } }, "/v1/trace-learn/tutor/dashboard": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnTutorDashboard", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "tutor", "cohortSize", "students", "assignments", "attention", "progress", "projectionFreshness" ], "properties": { "tutor": { "type": "object", "required": [ "id", "displayName" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" } }, "additionalProperties": false }, "cohortSize": { "type": "number" }, "students": { "type": "array", "items": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "streakDays", "lastActiveAt", "weakTopicNames", "strongTopicNames" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "streakDays": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "weakTopicNames": { "type": "array", "items": { "type": "string" } }, "strongTopicNames": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "assignments": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "subjectId", "subjectName", "type", "questionCount", "dueAt", "dueLabel", "status", "timeLimitMinutes" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "title": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "subjectName": { "type": "string" }, "type": { "type": "string", "enum": [ "mini-test", "test", "practice" ] }, "questionCount": { "type": "number" }, "dueAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "dueLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in-progress", "completed", "overdue" ] }, "timeLimitMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assignedStudentIds": { "type": "array", "items": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } } }, "additionalProperties": false } }, "attention": { "type": "array", "items": { "type": "object", "required": [ "studentId", "reason", "severity" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "reason": { "type": "string" }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false } }, "progress": { "type": "object", "required": [ "dateRange", "points" ], "properties": { "dateRange": { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "end": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false }, "points": { "type": "array", "items": { "type": "object", "required": [ "date", "week", "label", "studentId", "studentName", "overall", "maths", "english", "vr", "nvr" ], "properties": { "date": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "week": { "type": "string" }, "label": { "type": "string" }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentName": { "type": "string" }, "overall": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "maths": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "english": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "vr": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "nvr": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } } }, "additionalProperties": false }, "projectionFreshness": { "type": "object", "required": [ "asOf", "stale", "source" ], "properties": { "asOf": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "stale": { "type": "boolean" }, "source": { "type": "string", "enum": [ "fixture", "projection" ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnTutorDashboard()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_tutor_dashboard()" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-tutor-dashboard" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/dashboard\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/dashboard';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn tutor dashboard", "x-displayName": "Trace learn tutor dashboard" } }, "/v1/trace-learn/tutor/students": { "post": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.createTraceLearnTutorStudent", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "student", "credential", "link", "welcomeEmail", "message" ], "properties": { "student": { "type": "object", "required": [ "id", "displayName", "avatarId", "yearGroup", "targetSchool", "overallScore", "streakDays", "lastActiveAt", "weakTopicNames", "strongTopicNames" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "yearGroup": { "type": "string" }, "targetSchool": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "overallScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "streakDays": { "type": "number" }, "lastActiveAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, "weakTopicNames": { "type": "array", "items": { "type": "string" } }, "strongTopicNames": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "credential": { "type": "object", "required": [ "username", "pinSet", "setupRequired" ], "properties": { "username": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "pinSet": { "type": "boolean" }, "setupRequired": { "type": "boolean" } }, "additionalProperties": false }, "link": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "enum": [ "active", "invited", "pending_parent", "pending_tutor" ] } }, "additionalProperties": false }, "welcomeEmail": { "type": "object", "required": [ "notificationId", "recipientEmail", "status", "templateId", "sentAt" ], "properties": { "notificationId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "recipientEmail": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "status": { "type": "string", "enum": [ "pending", "sent", "failed", "bounced" ] }, "templateId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "sentAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] } }, "additionalProperties": false }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName", "parentEmail", "yearGroup" ], "properties": { "displayName": { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "minLength": 1, "maxLength": 160 }, "parentEmail": { "type": "string", "description": "a string matching the pattern ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "yearGroup": { "type": "string", "enum": [ "Year 4", "Year 5", "Year 6" ] }, "targetSchool": { "anyOf": [ { "type": "string", "description": "a string at most 160 character(s) long", "title": "maxLength(160)", "maxLength": 160 }, { "type": "null" } ] }, "avatarId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.createTraceLearnTutorStudent({\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.create_trace_learn_tutor_student(\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn create-trace-learn-tutor-student \\\n --request '{\"body\":{}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/students\", base_url.trim_end_matches('/'));\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.post(url).bearer_auth(token);\n request = request.json(&serde_json::json!({}));\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/students';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n 'Content-Type': 'application/json',\n };\n final response = await http.post(\n uri,\n headers: headers,\n body: jsonEncode({}),\n );\n print(response.body);\n}" } ], "summary": "Create trace learn tutor student", "x-displayName": "Create trace learn tutor student" } }, "/v1/trace-learn/tutor/students/{studentId}": { "delete": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.deleteTraceLearnTutorStudent", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.deleteTraceLearnTutorStudent({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.delete_trace_learn_tutor_student(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn delete-trace-learn-tutor-student \\\n --request '{\"path\":{\"studentId\":\"studentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/students/{}\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.delete(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/students/$studentId';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.delete(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Delete trace learn tutor student", "x-displayName": "Delete trace learn tutor student" } }, "/v1/trace-learn/tutor/students/{studentId}/lesson-completions": { "get": { "tags": [ "Trace Learn" ], "operationId": "traceLearn.getTraceLearnTutorStudentCompletions", "parameters": [ { "name": "studentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "studentId", "displayName", "totalCompleted", "passedCount", "failedCount", "completions" ], "properties": { "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string" }, "totalCompleted": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "passedCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "failedCount": { "type": "integer", "description": "a non-negative number", "title": "greaterThanOrEqualTo(0)", "minimum": 0 }, "completions": { "type": "array", "items": { "type": "object", "required": [ "id", "studentId", "lessonId", "segmentId", "lessonTitle", "subjectId", "attemptNumber", "status", "passed", "scoreCorrect", "scoreTotal", "scorePercent", "activeMs", "startedAt", "completedAt" ], "properties": { "id": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "studentId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "lessonId": { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, "segmentId": { "anyOf": [ { "type": "string", "description": "a string at most 128 character(s) long", "title": "maxLength(128)", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lessonTitle": { "type": "string" }, "subjectId": { "anyOf": [ { "type": "string", "enum": [ "maths", "english", "verbal-reasoning", "non-verbal-reasoning" ] }, { "type": "null" } ] }, "attemptNumber": { "type": "integer", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "status": { "type": "string" }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "scoreCorrect": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "scoreTotal": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "scorePercent": { "anyOf": [ { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "activeMs": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 }, { "type": "null" } ] }, "completedAt": { "type": "string", "description": "a string at least 10 character(s) long", "title": "minLength(10)", "minLength": 10 } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { TxAgentKitClient } from '@tx-agent-kit/sdk'\n\nconst client = new TxAgentKitClient({\n token: process.env.TX_AGENT_KIT_TOKEN\n})\n\nconst response = await client.traceLearn.getTraceLearnTutorStudentCompletions({\n studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? \"studentId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom tx_agent_kit_sdk import TxAgentKitClient\n\nclient = TxAgentKitClient(token=os.environ[\"TX_AGENT_KIT_TOKEN\"])\n\nresponse = client.trace_learn.get_trace_learn_tutor_student_completions(\n studentId=os.environ.get(\"TX_AGENT_KIT_STUDENT_ID\", \"studentId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "tx-agent-kit trace-learn get-trace-learn-tutor-student-completions \\\n --request '{\"path\":{\"studentId\":\"studentId\"}}'" }, { "lang": "rust", "label": "Rust", "source": "use reqwest::Client;\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), reqwest::Error> {\n let client = Client::new();\n let base_url = env::var(\"TX_AGENT_KIT_API_URL\").unwrap_or_else(|_| \"https://api.tx-agent-kit.dev\".to_string());\n let student_id = env::var(\"TX_AGENT_KIT_STUDENT_ID\").unwrap_or_else(|_| \"studentId\".to_string());\n let url = format!(\"{}/v1/trace-learn/tutor/students/{}/lesson-completions\", base_url.trim_end_matches('/'), student_id);\n let token = env::var(\"TX_AGENT_KIT_TOKEN\").expect(\"TX_AGENT_KIT_TOKEN\");\n let mut request = client.get(url).bearer_auth(token);\n let response = request.send().await?;\n println!(\"{}\", response.text().await?);\n Ok(())\n}" }, { "lang": "dart", "label": "Dart", "source": "import 'dart:convert';\nimport 'dart:io';\nimport 'package:http/http.dart' as http;\n\nFuture main() async {\n final baseUrl = Platform.environment['TX_AGENT_KIT_API_URL'] ?? 'https://api.tx-agent-kit.dev';\n final token = Platform.environment['TX_AGENT_KIT_TOKEN'];\n final studentId = Platform.environment['TX_AGENT_KIT_STUDENT_ID'] ?? 'studentId';\n final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/trace-learn/tutor/students/$studentId/lesson-completions';\n final uri = Uri.parse(url);\n final headers = {\n 'Authorization': 'Bearer $token',\n };\n final response = await http.get(\n uri,\n headers: headers,\n );\n print(response.body);\n}" } ], "summary": "Trace learn tutor student completions", "x-displayName": "Trace learn tutor student completions" } } }, "components": { "schemas": { "HttpApiDecodeError": { "type": "object", "required": [ "issues", "message", "_tag" ], "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "HttpApiDecodeError" ] } }, "additionalProperties": false, "description": "The request did not match the expected schema" }, "Issue": { "type": "object", "required": [ "_tag", "path", "message" ], "properties": { "_tag": { "type": "string", "enum": [ "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden" ], "description": "The tag identifying the type of parse issue" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyKey" }, "description": "The path to the property where the issue occurred" }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } }, "additionalProperties": false, "description": "Represents an error encountered while parsing a value to match the schema" }, "PropertyKey": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "required": [ "_tag", "key" ], "properties": { "_tag": { "type": "string", "enum": [ "symbol" ] }, "key": { "type": "string" } }, "additionalProperties": false, "description": "an object to be decoded into a globally shared symbol" } ] }, "BadRequest": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "BadRequest" ] } }, "additionalProperties": false }, "Unauthorized": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Unauthorized" ] } }, "additionalProperties": false }, "PaymentRequired": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "PaymentRequired" ] } }, "additionalProperties": false }, "Forbidden": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Forbidden" ] } }, "additionalProperties": false }, "NotFound": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "NotFound" ] } }, "additionalProperties": false }, "Conflict": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Conflict" ] } }, "additionalProperties": false }, "TooManyRequests": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "TooManyRequests" ] } }, "additionalProperties": false }, "InternalError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "InternalError" ] } }, "additionalProperties": false }, "UUID": { "type": "string", "description": "a Universally Unique Identifier", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Organizations", "description": "Organizations are the billing and membership boundary. List them to discover organization ids, then create or rename organizations as workspaces grow." }, { "name": "Teams", "description": "Teams partition an organization into workspaces. Most other endpoints are scoped by teamId, so list teams first to find the id you need." }, { "name": "Assets", "description": "The media library behind a team: upload files (URL, base64, or presigned upload for large files), then list, search, and organize assets and collections." }, { "name": "Trace Learn", "description": "The Trace Learn learning surface: diagnostics, lessons, attempts, tutor and parent dashboards, notifications, and privacy tooling, all scoped to a session." }, { "name": "Billing", "description": "Credit balance, usage history, and top-ups for an organization. Paid operations reserve credits up front and finalize after completion." }, { "name": "Storage" }, { "name": "Storage metering" }, { "name": "Roles" }, { "name": "Permissions" }, { "name": "Auth" }, { "name": "Email unsubscribe" } ], "servers": [ { "url": "https://api.tx-agent-kit.dev", "description": "tx-agent-kit Production API" } ], "x-ddd": { "boundedContexts": [ { "name": "IdentityAccess", "owns": [ "Sign up/sign in", "Session token principal" ] }, { "name": "Collaboration", "owns": [ "Organizations", "Teams", "Invitations", "Membership" ] } ], "closedInvariants": [ { "id": "INV-AUTH-001", "rule": "Password must be at least 8 characters." }, { "id": "INV-AUTH-002", "rule": "Forgot-password responses are account-enumeration safe." }, { "id": "INV-ORG-001", "rule": "Organization members are the only actors allowed to manage resources in that organization." }, { "id": "INV-INV-001", "rule": "Invitations can be accepted only when status is pending, not expired, and email matches authenticated principal." }, { "id": "INV-INV-002", "rule": "Invitation list visibility is scoped to invitations whose email matches the authenticated principal." }, { "id": "INV-ARCH-001", "rule": "Domain mutations are accepted only via API/application services; direct UI-to-DB writes are forbidden." } ] } }