docsloth.dev
Model schemas
121 shared models in one JSON Schema document. Generated clients and every server validate against these definitions, so the contract cannot drift between repositories.
Actions
Actions
- Download schema
Downloads the exact JSON Schema document rendered on this page, with Content-Disposition set. No account, no cost.
- Read migration
Opens the real migration component: published version and migration history, with its prop schema and fixture.
- Download OpenAPI contracts
The API page is generated from the published core OpenAPI document and lists every registered operation; the cloud contract mirrors the same envelope.
| Model | Type | Required fields |
|---|---|---|
ActionRequest | object | action, reason |
Actor | object | id, kind, org_id, scopes |
AgentInstallPlan | object | files, configuration, manual_steps, requested_scopes |
AgentInstallRequest | object | client, software_id, mode, write_project_instructions |
AnalyticsQuery | object | software_id, metric, from, to, group_by, filters |
AnalyticsResult | object | metric, rows, data_through, sampling_rate, limitations |
Approval | object | id, target_id, action, payload_hash, expires_at, state |
ApprovalDecision | object | decision, payload_hash |
Audience | object | id, label, intent, technical_depth, visibility |
AuditEvent | object | id, org_id, actor_id, action, target_id, timestamp, outcome, request_id, details_hash |
AuthorizationSession | object | id, authorization_url, expires_at |
AuthorizationStart | object | provider, purpose, return_path, requested_scopes |
Budget | object | id, scope, scope_id, limit_micro_usd, consumed_micro_usd, reserved_micro_usd, overages_enabled, revision |
BudgetUpdate | object | limit_micro_usd, overages_enabled, expected_revision |
CapabilityGrant | object | id, expires_at, operation, max_charge_micro_usd, opaque_token |
CapabilityRequest | object | component_instance_id, resource_id, operation, payload, environment, max_charge_micro_usd |
ChatAnswer | object | id, conversation_id, text, citations, unsupported_points, action_requests |
ChatRequest | object | publication_id, message, max_charge_micro_usd |
CheckoutRequest | object | plan, interval, quantity, return_path |
CheckoutSession | object | id, url, expires_at |
CheckResult | object | id, job_id, check, status, evidence_ids, details |
ComponentInstall | object | package, version, integrity |
ComponentInstance | object | id, package, version, integrity, props, bindings, fact_ids, mode |
ComponentManifest | object | name, version, protocol, license, description, runtime, trust_class, entry, integrity, props_schema, tools, resources, fallback, recording_policy, permissions |
ConsentReceipt | object | id, site_id, purposes, consented, policy_version, issued_at, expires_at |
ConsentRequest | object | site_id, purposes, consented, policy_version, receipt_nonce |
ContextPack | object | id, publication_id, text, fact_ids, evidence_ids, constraints, omissions, estimated_tokens, expires_at |
ContextRequest | object | task, publication_id, audience_id, token_budget, include_examples |
CredentialCreate | object | resource_id, secret |
DeploymentEvent | object | external_id, software_id, environment_id, status, revision_vector, occurred_at |
DiscoveryManifest | object | schema_version, generator, publication_id, canonical_origin, formats, visibility |
DocBlock | object | id, kind, content, fact_ids, evidence_ids, ownership, visibility, verification, revision |
DocPage | object | id, program_id, title, slug, locale, audience_id, snapshot_id, revision, blocks, seo |
DocPatch | object | id, page_id, base_revision, operations, reason, evidence_ids, requested_checks, actor_kind |
DocProgram | object | id, software_id, revision, objective, audiences, locales, source_ids, allowed_components, style, policies |
Domain | object | id, software_id, hostname, state, challenge_name, challenge_value, tls_state, revision |
DomainCreate | object | hostname, software_id |
EditorPlan | object | id, job_id, base_revision, summary, affected_page_ids, actions, estimated_charge_micro_usd, status |
EditorRequest | object | software_id, program_id, instruction, mode, expected_revision, max_charge_micro_usd |
Entitlement | object | id, package_name, license_version, allowed_versions, deployment_limit, status |
Environment | object | id, software_id, name, kind, source_mode, auto_publish, required_checks |
Evidence | object | id, source_id, snapshot_hash, path, method, visibility, content_hash |
Execution | object | id, state, artifact_ids |
Experiment | object | id, software_id, hypothesis, primary_metric, guardrails, state, variants, minimum_days, minimum_sessions_per_variant |
ExperimentCreate | object | hypothesis, primary_metric, guardrails, candidate_publication_ids |
Export | object | id, job_id, status, scope, scope_id, excluded_secret_refs |
ExportRequest | object | software_id, format, audience_ids, include_private |
Fact | object | id, subject_node, predicate, value, state, evidence_ids, visibility, snapshot_id |
FeedbackCreate | object | publication_id, page_id, rating, category |
FleetEnrollment | object | node_id, one_time_token, expires_at, control_plane_url |
FleetEnrollRequest | object | name, public_key, deployment_mode, requested_capabilities |
FleetNode | object | id, name, deployment_mode, core_version, protocol_version, last_heartbeat_at, status, capabilities, egress_policy |
ForgeRequest | object | software_id, brief, runtime, allowed_capabilities, max_charge_micro_usd, visibility |
ForgeResult | object | id, job_id, status, package_name, candidate_version, check_ids, capability_changes |
GraphEdge | object | id, source_node, target_node, kind, status, evidence_ids |
GraphNode | object | id, software_id, kind, name, qualified_name, evidence_ids, visibility, payload |
GraphSlice | object | nodes, edges, truncated, omitted_count, snapshot_id |
GrowthProposal | object | id, software_id, objective, evidence_refs, hypothesis, proposed_plan_id, status, expected_metric, uncertainties, revision |
Health | object | status, version, schema_version |
ImportRequest | object | upload_id, software_id, mode, dry_run |
IngestResult | object | accepted, rejected, duplicates |
InviteRequest | object | email, role, software_ids |
Invoice | object | id, provider_id, currency, status, subtotal_cents, tax_cents, total_cents, period_start, period_end |
Job | object | id, software_id, kind, stage, attempt, created_at, updated_at, input_hash |
JobEvent | object | id, job_id, stage, timestamp, message |
JobRequest | object | kind, dry_run, max_charge_micro_usd |
MediaAsset | object | id, software_id, content_type, sha256, size_bytes, status, visibility, alt_text, artifact_key, created_at |
MediaRequest | object | software_id, filename, content_type, size_bytes, sha256, visibility, alt_text, caption |
Membership | object | id, org_id, user_id, role, state |
Message | object | message, request_id |
ModelBinding | object | id, resource_id, model_id, role, mode, max_input_tokens, max_output_tokens, capabilities |
Notification | object | id, kind, title, body, target_path, created_at, read |
ObservationConnector | object | id, provider, resource_id, software_id, status, allowed_fields |
Order | object | id, org_id, seller_id, listing_id, state, subtotal_micro_usd, tax_micro_usd, fee_micro_usd, currency, created_at |
OrderRequest | object | listing_id, offer_id, license_version, quantity, approved_total_micro_usd, return_path |
PackageReview | object | package_id, version, decision, reason, evidence_ids |
PatchOp | object | op, path |
Policy | object | id, org_id, revision, name, rules |
PolicyCondition | union | — |
Problem | object | type, title, status, code, detail, request_id, retryable |
ProviderCallback | object | code, state |
ProviderInstallation | object | id, provider, provider_account, status, permissions, created_at |
Publication | object | id, software_id, release_id, program_revision, manifest_hash, artifact_prefix, status, canonical_origin, visibility |
PublisherBalance | object | currency, pending_cents, available_cents, reserved_cents, provider_account_id, last_synced_at |
PublishRequest | object | candidate_id, expected_live_id, payload_hash |
Quote | object | id, org_id, price_version, expires_at, maximum_charge_micro_usd, estimated_charge_micro_usd, line_items, approval_required |
RegistryItem | object | id, manifest, publisher_id, source_url, price_kind, state, verified_identity |
ReleaseManifest | object | id, software_id, mode, label, sources, deployment_ids, created_at, manifest_hash |
ReplayAccess | object | session_id, chunks, expires_at |
ReplaySession | object | id, software_id, publication_id, started_at, duration_ms, compressed_bytes, status, consent_receipt_id, chunk_count, retention_until |
ReplaySettings | object | text, updated_at, updated_by |
ReplaySettingsUpdate | object | text |
ReplayTextMode | string | — |
ReplayUpload | object | session_id, site_id, sequence, compressed_bytes, content_hash, consent_receipt_id, masked |
Resource | object | id, org_id, kind, provider, label, state, environment, allowed_operations, allowed_hosts, revision, credential_present |
ResourceCreate | object | kind, provider, label, environment, allowed_operations, allowed_hosts, configuration |
SecretFinding | object | id, page_id, surface, location, rule, detail, excerpt, acknowledged |
SecretFindingLocation | object | file |
SecretFindingsAcknowledgement | object | software_id, acknowledged, already_acknowledged, acknowledged_by, acknowledged_at |
SecretFindingsAcknowledgeRequest | object | ids |
SecretFindingsProblem | object | type, title, status, code, detail, request_id, retryable, software_id, publication_id, findings, findings_total, acknowledged_total, acknowledge_url, review_url |
SecretFindingsReview | object | publication_id, software_id, visibility, status, schema, detector_version, scanned_at, files_scanned, counts, blocking, findings, truncated, acknowledge_url |
SecretFindingsUnknown | object | status, code, detail, unknown_ids |
ShareLink | object | id, url, expires_at, visibility, publication_id |
ShareRequest | object | answer_id, expires_in_seconds, visibility, redacted |
Software | object | id, org_id, name, slug, state, revision, created_at |
SoftwareCreate | object | name, slug, objective, visibility |
SourceBinding | object | id, software_id, provider, external_id, locator, subpath, ref, visibility, state, revision |
SourceCandidate | object | installation_id, external_id, provider, full_name, default_branch, private, readable, clone_url |
SourceCreate | object | provider, external_id, locator, subpath, ref, visibility |
Subscription | object | id, plan, state, current_period_start, current_period_end, cancel_at_period_end |
TelemetryBatch | object | events |
TelemetryEvent | object | id, site_id, event, timestamp, consent, properties |
UploadGrant | object | id, upload_url, expires_at, max_bytes |
UsageEvent | object | event_id, org_id, software_id, meter, quantity, rate_version, source, occurred_at, mode, internal_fault |
UserProfile | object | id, email, display_name, workspace_ids, roles, mfa_enrolled |
WebhookAck | object | accepted, delivery_id, duplicate |
WebhookHook | object | id, provider, url, created_at, created_by, revoked_at |
WebhookHookCreate | object | provider |
Workspace | object | id, name, slug, plan, created_at, revision |
WorkspaceCreate | object | name, slug |