Skip to content
Kindgi

Models: S

ScheduleCollectionPage

Section titled “ScheduleCollectionPage”
  • data: list[kindgi.client.ScheduleRecord]
  • next_cursor: str | None (nextCursor on the wire) (optional)
  • has_more: bool (hasMore on the wire)

ScheduleRecord

Section titled “ScheduleRecord”
  • schedule_id: str (scheduleId on the wire)
  • trigger_id: str (triggerId on the wire)
  • flow_id: str (flowId on the wire)
  • flow_version: str (flowVersion on the wire)
  • cron_expression: str (cronExpression on the wire)
  • timezone: str | None (optional)
  • input: Any | None (optional)
  • label: str | None
  • status: Literal['active', 'paused']
  • next_fire_at: AwareDatetime | None (nextFireAt on the wire)
  • last_fired_at: AwareDatetime | None (lastFiredAt on the wire)
  • created_at: AwareDatetime (createdAt on the wire)
  • updated_at: AwareDatetime (updatedAt on the wire)

ScheduleUnregisterResult

Section titled “ScheduleUnregisterResult”
  • schedule_id: str (scheduleId on the wire)
  • unregistered: bool

Scope1

Section titled “Scope1”

Discriminated Scope primitive (Tenant / Org / Project). Source of truth: Scope in @kindgi/platform.

  • kind: Literal['tenant']
  • tenant_id: str (tenantId on the wire)

Scope2

Section titled “Scope2”

Discriminated Scope primitive (Tenant / Org / Project). Source of truth: Scope in @kindgi/platform.

  • kind: Literal['org']
  • tenant_id: str (tenantId on the wire)
  • org_id: str (orgId on the wire)

Scope3

Section titled “Scope3”

Discriminated Scope primitive (Tenant / Org / Project). Source of truth: Scope in @kindgi/platform.

  • kind: Literal['project']
  • tenant_id: str (tenantId on the wire)
  • project_id: str (projectId on the wire)

SecretCollectionPage

Section titled “SecretCollectionPage”
  • data: list[kindgi.client.SecretRecord]
  • next_cursor: str | None (nextCursor on the wire) (optional)

SecretListPage

Section titled “SecretListPage”
  • data: list[kindgi.client.SecretRecord]
  • next_cursor: str | None (nextCursor on the wire) (optional)

SecretRecord

Section titled “SecretRecord”
  • scope: kindgi.client.Scope1 | kindgi.client.Scope2 | kindgi.client.Scope3
  • env_name: str (envName on the wire)
  • name: str
  • current_version: int (currentVersion on the wire)
  • created_at: AwareDatetime (createdAt on the wire)
  • updated_at: AwareDatetime (updatedAt on the wire)
  • revoked_at: AwareDatetime | None (revokedAt on the wire) (optional)
  • revoke_reason: str | None (revokeReason on the wire) (optional)
  • tags: dict[str, str] | None (optional)
  • rotation_due_at: AwareDatetime | None (rotationDueAt on the wire) (optional)

SecretRef

Section titled “SecretRef”

The tenant secret holding the adapter's credential (an API key, a service-account key). Absent when the adapter needs none or finds its own (a cloud's default credentials).

  • env_name: str (envName on the wire)
  • name: str

SecretResolveOutcome

Section titled “SecretResolveOutcome”
  • name: str
  • version_id: int (versionId on the wire)
  • value: str

SecretRevokeOutcome

Section titled “SecretRevokeOutcome”
  • revoked: bool
  • hard: bool

SecretRevokeResult

Section titled “SecretRevokeResult”
  • revoked: bool
  • hard: bool

SecretRotateOutcome

Section titled “SecretRotateOutcome”
  • root: kindgi.client.SecretRotateOutcome1 | kindgi.client.SecretRotateOutcome2

SecretRotateOutcome1

Section titled “SecretRotateOutcome1”
  • kind: Literal['ok']
  • new_version_id: int (newVersionId on the wire)
  • old_version_id: int (oldVersionId on the wire)
  • old_version_revoked_at: AwareDatetime | None (oldVersionRevokedAt on the wire) (optional)

SecretRotateOutcome2

Section titled “SecretRotateOutcome2”
  • kind: Literal['rotation-pending']
  • resume_token: str (resumeToken on the wire)
  • provider: str

SecretRotateRequest

Section titled “SecretRotateRequest”
  • scope: kindgi.client.Scope1 | kindgi.client.Scope2 | kindgi.client.Scope3 | None (optional)
  • env_name: str | None (envName on the wire) (optional)
  • new_value: str | None (newValue on the wire) (optional)
  • revoke_old_after_ms: int | None (revokeOldAfterMs on the wire) (optional)

SecretRotateResponseAsync

Section titled “SecretRotateResponseAsync”
  • kind: Literal['async']
  • rotation_id: uuid.UUID (rotationId on the wire)
  • status_url: str (statusUrl on the wire)
  • events_url: str (eventsUrl on the wire)

SecretRotateResponseSync

Section titled “SecretRotateResponseSync”
  • kind: Literal['sync']
  • new_version_id: int (newVersionId on the wire)
  • old_version_id: int (oldVersionId on the wire)
  • old_version_revoked_at: AwareDatetime | None (oldVersionRevokedAt on the wire) (optional)

SecretSetInput

Section titled “SecretSetInput”
  • scope: kindgi.client.Scope1 | kindgi.client.Scope2 | kindgi.client.Scope3
  • env_name: str (envName on the wire)
  • name: str
  • value: str
  • write_mode: Literal['create-new', 'add-version'] (writeMode on the wire)
  • tags: dict[str, str] | None (optional)
  • rotation_due_at: AwareDatetime | None (rotationDueAt on the wire) (optional)
  • if_version: int | None (ifVersion on the wire) (optional)

SecretSetOutcome

Section titled “SecretSetOutcome”
  • root: kindgi.client.SecretSetOutcome1 | kindgi.client.SecretSetOutcome2 | kindgi.client.SecretSetOutcome3 | kindgi.client.SecretSetOutcome4

SecretSetOutcome1

Section titled “SecretSetOutcome1”
  • kind: Literal['ok']
  • record: kindgi.client.SecretRecord
  • version_id: int (versionId on the wire)

SecretSetOutcome2

Section titled “SecretSetOutcome2”
  • kind: Literal['already-exists']
  • record: kindgi.client.SecretRecord

SecretSetOutcome3

Section titled “SecretSetOutcome3”
  • kind: Literal['version-conflict']
  • current_version: int (currentVersion on the wire)

SecretSetOutcome4

Section titled “SecretSetOutcome4”
  • kind: Literal['error']
  • code: str
  • message: str

SecretSetRequest

Section titled “SecretSetRequest”
  • scope: kindgi.client.Scope1 | kindgi.client.Scope2 | kindgi.client.Scope3
  • env_name: str (envName on the wire)
  • name: str
  • value: str
  • write_mode: Literal['create-new', 'add-version'] (writeMode on the wire)
  • tags: dict[str, str] | None (optional)
  • rotation_due_at: AwareDatetime | None (rotationDueAt on the wire) (optional)
  • if_version: int | None (ifVersion on the wire) (optional)

SecretSetResponse

Section titled “SecretSetResponse”
  • record: kindgi.client.SecretRecord
  • version_id: int (versionId on the wire)

SecretVersionCollectionPage

Section titled “SecretVersionCollectionPage”
  • data: list[kindgi.client.SecretVersionRecord]
  • next_cursor: str | None (nextCursor on the wire) (optional)

SecretVersionRecord

Section titled “SecretVersionRecord”
  • scope: kindgi.client.Scope1 | kindgi.client.Scope2 | kindgi.client.Scope3
  • env_name: str (envName on the wire)
  • name: str
  • version_id: int (versionId on the wire)
  • created_at: AwareDatetime (createdAt on the wire)
  • value: str | None (optional)
  • revoked_at: AwareDatetime | None (revokedAt on the wire) (optional)

Secrets

Section titled “Secrets”
  • name: str
  • ref: str

Secrets1

Section titled “Secrets1”
  • name: str
  • value: str

Signature

Section titled “Signature”

Runtime-side signature attached at emission time (if the deployment signs on write). Independent of the export-time signature returned by the export route.

  • algorithm: Literal['ed25519']
  • key_id: str (keyId on the wire)
  • value: str
  • signed_at: AwareDatetime (signedAt on the wire)

Signature1

Section titled “Signature1”
  • algorithm: Literal['ed25519']
  • key_id: str (keyId on the wire)
  • value: str
  • signed_at: AwareDatetime (signedAt on the wire)

SignedComplianceEvidenceBundle

Section titled “SignedComplianceEvidenceBundle”

Signed exportable bundle. bundle is base64 of the exact bytes that were signed (sorted-key canonical JSON, no whitespace); verifiers can pass those bytes directly to verifyEd25519. Bundle body: { bundleSchemaVersion, tenantId, filter, records, recordCount, exportedAt }. Envelope shape identical to ExportProvenanceResult + audit-bundle — verifiers reuse one verifyEd25519 wrapper across all three surfaces.

  • bundle_schema_version: Literal['1.0.0'] (bundleSchemaVersion on the wire)
  • tenant_id: uuid.UUID (tenantId on the wire)
  • bundle: str
  • algorithm: Literal['ed25519']
  • signing_key_id: str (signingKeyId on the wire)
  • signature: str
  • public_key: str (publicKey on the wire)
  • canonicalization: Literal['sorted-key-json']
  • exported_at: AwareDatetime (exportedAt on the wire)

SourceFreshness

Section titled “SourceFreshness”
  • ttl_seconds: int | None (ttlSeconds on the wire) (optional)
  • last_verified_at: AwareDatetime | None (lastVerifiedAt on the wire) (optional)
  • etag: str | None (optional)
  • source_version: str | None (sourceVersion on the wire) (optional)

SourceRefresh

Section titled “SourceRefresh”
  • strategy: Literal['on-read', 'background', 'manual']
  • handler: str | None (optional)
  • priority: int | None (optional)

StartEvalRunBody

Section titled “StartEvalRunBody”

Exactly one of agentRef or flowRef MUST be supplied. dryRun: true returns a plan preview without invoking the subject.

  • project_id: uuid.UUID (projectId on the wire)
  • agent_ref: kindgi.client.EvalRunAgentRef | None (agentRef on the wire) (optional)
  • flow_ref: kindgi.client.EvalRunFlowRef | None (flowRef on the wire) (optional)
  • dry_run: bool | None (dryRun on the wire) (optional)
  • correlation_id: str | None (correlationId on the wire) (optional)

StartEvalRunResult

Section titled “StartEvalRunResult”
  • run_id: uuid.UUID (runId on the wire)
  • dry_run_preview: dict[str, Any] | None (dryRunPreview on the wire) (optional)

StartRunBody

Section titled “StartRunBody”
  • root: kindgi.client.StartRunBody1 | kindgi.client.StartRunBody2

StartRunBody1

Section titled “StartRunBody1”

Start a run. Exactly one of agent or flow MUST be supplied (single Run primitive).

  • agent: str
  • agent_version: str | None (agentVersion on the wire) (optional)
  • project_id: uuid.UUID | None (projectId on the wire) (optional)
  • input: Any
  • options: kindgi.client.Options | None (optional)

StartRunBody2

Section titled “StartRunBody2”

Start a run. Exactly one of agent or flow MUST be supplied (single Run primitive).

  • flow: str
  • flow_version: str | None (flowVersion on the wire) (optional)
  • project_id: uuid.UUID | None (projectId on the wire) (optional)
  • input: Any
  • options: kindgi.client.Options | None (optional)

StartRunOptions

Section titled “StartRunOptions”
  • dry_run: bool | None (dryRun on the wire) (optional)
  • wait: bool | None (optional)

Subject

Section titled “Subject”
  • kind: str | None (optional)
  • id: str | None (optional)

SubmitReviewProposalBody

Section titled “SubmitReviewProposalBody”

Body is optional — omit to accept every default. requiredRole overrides the auto-derivation (meta-fixes → senior). expiresAt sets the HITL approval deadline.

  • required_role: Optional[Literal['standard', 'senior', 'admin']] (requiredRole on the wire) (optional)
  • expires_at: AwareDatetime | None (expiresAt on the wire) (optional)

SubmitReviewProposalResult

Section titled “SubmitReviewProposalResult”
  • proposal: kindgi.client.FixProposal
  • approval_id: uuid.UUID (approvalId on the wire)
  • meta_fix: bool (metaFix on the wire)

SuccessStatus

Section titled “SuccessStatus”
  • min: int
  • max: int

SupersedeFactResult

Section titled “SupersedeFactResult”
  • fact_id: str (factId on the wire)
  • superseded: Literal[True]

SystemOpenapiResponse

Section titled “SystemOpenapiResponse”