Skip to content
Kindgi

Models: C

CallbackBody

Section titled “CallbackBody”
  • code: str
  • state: str

CallbackResult

Section titled “CallbackResult”
  • session_token: str (sessionToken on the wire)
  • session_id: str (sessionId on the wire)
  • expires_at: AwareDatetime (expiresAt on the wire)

Capability

Section titled “Capability”
  • root: str

Capability4

Section titled “Capability4”

Capability declaration — see @kindgi/capabilities. Additional properties are permitted so new capability kinds do not require a wire change.

Capability5

Section titled “Capability5”
  • root: str

CapabilityCollectionPage

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

CapabilityDescriptor

Section titled “CapabilityDescriptor”
  • id: str
  • feature: Union[str, Literal['structured-output', 'vision', 'audio-input', 'audio-output', 'tool-use', 'parallel-tool-use', 'thinking', 'long-context', 'code-execution', 'web-search', 'file-search', 'streaming', 'batch']]
  • description: str
  • kind: str | None (optional)
  • params_schema: dict[str, Any] | None (paramsSchema on the wire) (optional)

ClaimMappingScopesSpec

Section titled “ClaimMappingScopesSpec”

Claim path + optional delimiter for extracting Kindgi OAuth scopes from provider claims. When absent, scopes come from the token response scope field instead.

  • claim: str
  • delimiter: str | None (optional)

ClaimMappingSpec

Section titled “ClaimMappingSpec”

Per-provider claim mapping. All fields optional; closer to OIDC defaults (sub/email/name) → fewer overrides needed.

  • user_id: str | None (userId on the wire) (optional)
  • email: str | None (optional)
  • display_name: str | None (displayName on the wire) (optional)
  • scopes: kindgi.client.ClaimMappingScopesSpec | None (optional)
  • metadata: list[kindgi.client.Metadatum] | None (optional)

CodeArtifactRef1

Section titled “CodeArtifactRef1”

Handler-artifact pointer. Discriminated on kind: oci is the deploy-pipeline shape (image + module path + artifactVersion); filesystem is the local-development shape — absolute host path at the pack's on-disk handler file. Production servers SHOULD reject filesystem.

  • kind: Literal['oci']
  • image_ref: str (imageRef on the wire)
  • module_path: str (modulePath on the wire)
  • artifact_version: str (artifactVersion on the wire)

CodeArtifactRef2

Section titled “CodeArtifactRef2”

Handler-artifact pointer. Discriminated on kind: oci is the deploy-pipeline shape (image + module path + artifactVersion); filesystem is the local-development shape — absolute host path at the pack's on-disk handler file. Production servers SHOULD reject filesystem.

  • kind: Literal['filesystem']
  • module_path: str (modulePath on the wire)

CompleteApprovalBody

Section titled “CompleteApprovalBody”
  • decision: Literal['approve', 'reject', 'escalate', 'withdraw']
  • rationale: str | None (optional)
  • value: Any | None (optional)

CompleteApprovalResult

Section titled “CompleteApprovalResult”
  • kind: Literal['terminal', 'escalated']
  • approval: kindgi.client.Approval
  • decision: kindgi.client.ReviewDecision
  • next_approval: kindgi.client.Approval | None (nextApproval on the wire) (optional)
  • waitpoint_resolved: bool (waitpointResolved on the wire)

ComplianceEvidence

Section titled “ComplianceEvidence”

One evidence record — matches @kindgi/specs/compliance-evidence.schema.json (payload is a versioned document opaque to the wire schema).

  • id: str
  • tenant_id: uuid.UUID (tenantId on the wire)
  • project_id: uuid.UUID | None (projectId on the wire) (optional)
  • kind: str
  • timestamp: AwareDatetime
  • actor: kindgi.client.Actor | None (optional)
  • subject: kindgi.client.Subject | None (optional)
  • outcome: Optional[Literal['allowed', 'denied', 'succeeded', 'failed', 'escalated']] (optional)
  • payload: dict[str, Any]
  • provenance_ref: kindgi.client.ProvenanceRef2 | None (provenanceRef on the wire) (optional)
  • signature: kindgi.client.Signature1 | None (optional)

ComplianceEvidenceCollectionPage

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

Config

Section titled “Config”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['stdio']
  • command: str
  • args: list[str] | None (optional)
  • env: dict[str, str] | None (optional)

Config1

Section titled “Config1”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['http-sse']
  • url: AnyUrl
  • sse_url: AnyUrl | None (sseUrl on the wire) (optional)
  • headers: dict[str, str] | None (optional)

Config10

Section titled “Config10”
  • input: Any | None (optional)

Config2

Section titled “Config2”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['streamable-http']
  • url: AnyUrl
  • headers: dict[str, str] | None (optional)

Config3

Section titled “Config3”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['stdio']
  • command: str
  • args: list[str] | None (optional)
  • env: dict[str, str] | None (optional)

Config4

Section titled “Config4”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['http-sse']
  • url: AnyUrl
  • sse_url: AnyUrl | None (sseUrl on the wire) (optional)
  • headers: dict[str, str] | None (optional)

Config5

Section titled “Config5”

Transport-tagged config union. Server enforces config.transport === transport at registration.

  • transport: Literal['streamable-http']
  • url: AnyUrl
  • headers: dict[str, str] | None (optional)

Config6

Section titled “Config6”
  • cron_expression: str (cronExpression on the wire)
  • timezone: str | None (optional)
  • input: Any | None (optional)

Config7

Section titled “Config7”
  • cron_expression: str | None (cronExpression on the wire) (optional)
  • timezone: str | None (optional)
  • input: Any | None (optional)

Config8

Section titled “Config8”
  • event_kind: str (eventKind on the wire)
  • input: Any | None (optional)

Config9

Section titled “Config9”
  • event_kind: str | None (eventKind on the wire) (optional)
  • input: Any | None (optional)

Content

Section titled “Content”
  • type: Literal['text']
  • text: str

Content1

Section titled “Content1”
  • type: Literal['image']
  • data: str
  • mime_type: str (mimeType on the wire)

Conversation

Section titled “Conversation”
  • id: uuid.UUID
  • tenant_id: uuid.UUID (tenantId on the wire)
  • agent_id: str (agentId on the wire)
  • agent_version: str (agentVersion on the wire)
  • title: str
  • participant_id: str | None (participantId on the wire) (optional)
  • scope: dict[str, Any]
  • status: Literal['open', 'closed']
  • opened_at: AwareDatetime (openedAt on the wire)
  • closed_at: AwareDatetime | None (closedAt on the wire) (optional)
  • turn_count: int (turnCount on the wire)
  • last_message_at: AwareDatetime | None (lastMessageAt on the wire) (optional)
  • metadata: dict[str, Any] | None (optional)

ConversationCollectionPage

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

ConversationMessage

Section titled “ConversationMessage”
  • sequence: int
  • role: Literal['user', 'agent', 'tool', 'system']
  • content: Any
  • tool_call: kindgi.client.ToolCall | None (toolCall on the wire) (optional)
  • actor: str | None (optional)
  • created_at: AwareDatetime (createdAt on the wire)

ConversationMessageCollectionPage

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

ConversationPolicy

Section titled “ConversationPolicy”
  • history_limit: int | None (historyLimit on the wire) (optional)
  • auto_close_after_inactive_seconds: int | None (autoCloseAfterInactiveSeconds on the wire) (optional)
  • hitl_after_turns: int | None (hitlAfterTurns on the wire) (optional)

ConversationStatus

Section titled “ConversationStatus”
  • root: Literal['open', 'closed']

CostAggregateGroup

Section titled “CostAggregateGroup”
  • key: dict[str, str | None]
  • count: int
  • total_usd: float (totalUsd on the wire)

CostAggregateResult

Section titled “CostAggregateResult”
  • groups: list[kindgi.client.CostAggregateGroup]
  • total_usd: float (totalUsd on the wire)
  • total_records: int (totalRecords on the wire)
  • time_range: kindgi.client.TimeRange (timeRange on the wire)
  • group_by: list[Literal['agentId', 'runId', 'category', 'providerId', 'day', 'month', 'tenant', 'conversationId']] (groupBy on the wire)

CostRecord

Section titled “CostRecord”
  • id: str
  • tenant_id: uuid.UUID (tenantId on the wire)
  • category: str
  • provider_id: str | None (providerId on the wire) (optional)
  • run_id: uuid.UUID | None (runId on the wire) (optional)
  • agent_id: str | None (agentId on the wire) (optional)
  • conversation_id: uuid.UUID | None (conversationId on the wire) (optional)
  • quantity: float
  • unit: str
  • cost_usd: float | None (costUsd on the wire) (optional)
  • occurred_at: AwareDatetime (occurredAt on the wire)
  • metrics: dict[str, Any] | None (optional)
  • attributes: dict[str, Any] | None (optional)

CostRecordCollectionPage

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

CreateResourceResult

Section titled “CreateResourceResult”

Shared 201 response body for platform-hierarchy create endpoints — the freshly-assigned id of the created row.

  • id: str

CreateWebhookEndpointBody

Section titled “CreateWebhookEndpointBody”
  • url: AnyUrl
  • events: list[Literal['run.finished']]
  • filter: kindgi.client.WebhookEndpointFilter | None (optional)
  • secret_ref: kindgi.client.WebhookSecretRef (secretRef on the wire)
  • description: str | None (optional)

Criterion

Section titled “Criterion”

How the dry-run judges whether the candidate is good enough to submit for review. Two kinds: min-pass-rate (candidate pass rate ≥ threshold) or strict-improvement (candidate pass rate exceeds baseline by ≥ delta).

  • kind: Literal['min-pass-rate']
  • min_pass_rate: float (minPassRate on the wire)

Criterion1

Section titled “Criterion1”

How the dry-run judges whether the candidate is good enough to submit for review. Two kinds: min-pass-rate (candidate pass rate ≥ threshold) or strict-improvement (candidate pass rate exceeds baseline by ≥ delta).

  • kind: Literal['strict-improvement']
  • baseline_pass_rate: float (baselinePassRate on the wire)
  • min_delta: float (minDelta on the wire)