Type Reference
All response models are Pydantic v2 BaseModel classes and can be imported from touai.types.
Auth Types
| Type | Key Fields |
|---|---|
AuthTokens | access_token, refresh_token, token_type, context, organization_id |
RegisterResponse | id, email, email_verified, message |
User | id, email, full_name, is_active, email_verified |
WorkspaceOverview | organizations, has_organizations, personal_workspace |
API Key Types
| Type | Key Fields |
|---|---|
ApiKey | access_key_id, user_id, organization_id, is_active |
ApiKeyCreated | access_key_id, secret_key |
ApiKeyRotated | access_key_id, secret_key |
ApiKeyValidation | valid, user_id, email, organization_id |
Organization Types
| Type | Key Fields |
|---|---|
Organization | id, name, slug, description, owner_id |
OrganizationDetail | inherits Organization plus members, services |
Member | id, user_id, role, email, full_name |
Invitation | id, organization_id, organization_name, role, status |
MemberPermission | service_type, permission_level |
AvailableService | service_type, is_enabled, display_name |
Context Layer Types
| Type | Key Fields |
|---|---|
ConnectorType | name, short_name, auth_methods, capabilities |
Connection | connection_id, id, name, connector_type, status |
ConnectionDetail | inherits Connection plus credentials_summary |
ConnectionList | items, total, active_count, page |
ConnectionTestResult | success, message, latency_ms |
SchemaDiscovery | connection_id, connector_type, discovered_schema |
QueryResult | success, data, columns, row_count |
SyncConfig | connection_id, enabled, strategy, interval_minutes |
SyncStatus | connection_id, sync_enabled, is_ready, total_entities, total_chunks |
SearchResults | query, results, total_results, retrieval_strategy |
Unstructured Types
| Type | Key Fields |
|---|---|
Job | job_id, status, progress, result, chunks |
BatchJob | batch_id, status, total, completed, failed, jobs |
UnstructuredFile | file_id, filename, file_type, status, progress |
UnstructuredFileDetail | inherits UnstructuredFile plus result, metadata |
SupportedFormats | categories |
VideoSearchResults | query, results, total |
EmbeddingStats | total_embeddings, total_videos, per_video |
EmbeddingCoverage | total_videos, embedded_videos, missing_videos |
Search, Research, and Storage Types
| Type | Key Fields |
|---|---|
ScrapeResult | success, url, markdown, html, links, media, metadata |
WebSearchResult | success, query, results, total_results |
CrawlTask | success, task_id |
CrawlStatus | success, status, data, pages, error |
ResearchResult | content, mode, tool_calls_count, citations, sources, usage |
ResearchEvent | type, data |
StorageInfo | organizations, projects, buckets |
StoredObject | key, bucket, project, size, url |
ObjectList | objects, total, prefixes, is_truncated, next_continuation_token |
Billing Types
| Type | Key Fields |
|---|---|
CreditBalance | balance, total_purchased, total_consumed, balance_in_usd |
CreditPackage | package_id, credits, price_cents, price_display |
CreditTransaction | id, type, amount, balance_after, service_type |
Plan | plan_id, name, price_cents, interval, credits_included |
Subscription | id, plan_id, plan_name, status, credits_included, credits_used |
CheckoutSession | checkout_url, checkout_session_id |
Invoice | id, amount_due, status, hosted_invoice_url |
PaymentMethod | id, type, card, is_default |
SetupIntent | setup_intent_id, client_secret |