Skip to content
Kindgi
Search
Ctrl
K
Cancel
GitHub
Version
Select theme
Dark
Light
Auto
Menu
Start
Overview
What is Kindgi?
Install
Quickstart: TypeScript
Quickstart: Python
Add Kindgi to an existing app
Your coding agent
Tutorials
Overview
Guides
Overview
Concepts
Overview
How Kindgi fits your app
Packs and primitives
Runs, the journal and durability
Security
Licensing
Deploy
Overview
Self-host Kindgi
Reference
Overview
HTTP API
Overview
System
Overview
Liveness probe
GET
OpenAPI 3.1 spec document
GET
Runs
Overview
List runs
GET
Start a run
POST
Fetch a run
GET
Cancel a run
POST
Resume a suspended run at a waitpoint
POST
Read the durable journal for a run
GET
Server-Sent Events stream of RunEvent frames
GET
A run's progress (status and timing, no data)
GET
Server-Sent Events stream of a run's progress
GET
Signing keys
Overview
List trusted signing keys
GET
Trust a signing key
POST
Get a signing key
GET
Revoke a signing key
POST
Tokens
Overview
List API keys
GET
Mint an API key
POST
Read an API key
GET
Revoke an API key
POST
Mint a public run token
POST
Approvals
Overview
List approvals visible to the caller
GET
Fetch a single approval
GET
Submit a decision on an approval
POST
List reviewers registered for the caller's tenant
GET
Register a reviewer
POST
Fetch a reviewer
GET
Unregister (soft-delete) a reviewer
POST
Export a signed audit bundle for a decided approval
POST
Agents
Overview
List agents
GET
Publish an agent definition
POST
Fetch the latest version of an agent
GET
List versions of an agent
GET
Fetch a specific agent version
GET
Unregister a specific agent version
POST
Reinstate a specific tombstoned agent version
POST
Flows
Overview
List flows
GET
Publish a flow definition
POST
Fetch the latest version of a flow
GET
List versions of a flow
GET
Fetch a specific flow version
GET
Unregister a specific flow version
POST
Reinstate a specific tombstoned flow version
POST
Tools
Overview
List tools
GET
Register a tool manifest
POST
Fetch a tool manifest (latest active version)
GET
List all versions of a tool
GET
Fetch a specific tool version
GET
Unregister a specific tool version
POST
Reinstate a specific tombstoned tool version
POST
Guardrails
Overview
List guardrails
GET
Register an guardrail
POST
Fetch an guardrail
GET
Unregister an guardrail
POST
Conversations
Overview
List conversations
GET
Open a conversation
POST
Fetch a conversation
GET
Close a conversation
POST
Read conversation messages
GET
Memory
Overview
List facts
GET
Write a fact
POST
Fetch a fact
GET
Mark a fact as superseded
POST
Retrieve facts by intent
POST
Proposals
Overview
List supervisor fix proposals
GET
Draft a fix proposal
POST
Fetch a fix proposal
GET
Dry-run a proposal against an eval dataset
POST
Submit a dry-run-passed proposal for HITL review
POST
Apply an approved proposal
POST
Roll back an applied proposal
POST
Withdraw a non-terminal proposal
POST
Provenance
Overview
List provenance records
GET
Fetch the full provenance DAG for a run
GET
Export a signed provenance bundle for a run
POST
Artifacts
Overview
List artifact metadata
GET
Upload an artifact
POST
Download an artifact (stream)
GET
Delete an artifact
DELETE
Fetch artifact metadata (no body)
HEAD
Observations
Overview
Query supervisor observations
GET
Capabilities
Overview
List capability descriptors
GET
Fetch a capability descriptor
GET
Providers
Overview
List model providers
GET
Register a model provider
POST
Fetch a provider
GET
List capabilities a provider satisfies
GET
Unregister a model provider
POST
MCP
Overview
List MCP endpoints
GET
Register an MCP endpoint
POST
Fetch an MCP endpoint
GET
Unregister an MCP endpoint
POST
List resources at a remote MCP endpoint
GET
Read a single resource at a remote MCP endpoint
GET
List prompts at a remote MCP endpoint
GET
Resolve a prompt template at a remote MCP endpoint
POST
Cost
Overview
List cost records
GET
Fetch a cost record
GET
Aggregate cost across a time window
GET
Adapters
Overview
List wired adapters
GET
Fetch a wired adapter
GET
Run a kind-specific smoke probe against an adapter
POST
Stream adapter preparation events (SSE)
POST
Policies
Overview
List tenant policies
GET
Publish a policy
POST
Fetch a policy (latest version)
GET
List versions of a policy
GET
Fetch a specific policy version
GET
Unregister a policy version
POST
Reinstate a specific tombstoned policy version
POST
Eval suites
Overview
List tenant eval suites
GET
Publish an eval suite
POST
Fetch an eval suite (latest version)
GET
List versions of an eval suite
GET
Fetch a specific eval suite version
GET
Unregister an eval suite version
POST
Reinstate a specific tombstoned eval suite version
POST
Eval runs
Overview
Start an eval run against a suite
POST
List eval runs
GET
Fetch an eval run
GET
Cancel an eval run
POST
Stream eval-run events (SSE)
GET
Auth
Overview
List identity providers configured for the tenant
GET
Register a new OAuth/OIDC identity provider
POST
Unregister an identity provider
POST
Initiate OAuth/OIDC login
POST
Complete an OAuth/OIDC callback
POST
Refresh the current session token
POST
Revoke the current session
POST
Identity
Overview
List users in the tenant
GET
Get a user by id
GET
List active sessions for a user
GET
Revoke every active session for a user
POST
Self — the caller's user + tenant + session context
GET
Deployments
Overview
List signed deployments
GET
Register a signed deployment
POST
Fetch a signed deployment record
GET
Sync secrets against a deployment
POST
Compliance
Overview
List compliance-evidence records
GET
Fetch one compliance-evidence record
GET
Export a signed compliance-evidence bundle
POST
Audit
Overview
List authz decision audit events
GET
Orgs
Overview
List orgs in the caller's tenant
GET
Create an org
POST
Fetch an org by id
GET
Delete an org (idempotent)
DELETE
Partially update an org
PATCH
Teams
Overview
List teams in the caller's tenant
GET
Create a team
POST
Fetch a team by id
GET
Delete a team (idempotent, cascades memberships)
DELETE
Partially update a team
PATCH
List memberships of a team
GET
Add a user to a team
POST
Remove a user from a team (idempotent)
DELETE
Change an existing member's role
PATCH
Projects
Overview
Fetch the tenant's Default project
GET
List projects in the caller's tenant
GET
Create a project
POST
Fetch a project by id
GET
Delete a project (idempotent)
DELETE
Partially update a project
PATCH
List direct memberships of a project
GET
Add a user directly to a project
POST
Remove a user from a project (idempotent)
DELETE
Change an existing project member's role
PATCH
Tenant
Overview
Fetch the caller's tenant
GET
List the tenant's config entries
GET
Upsert a tenant-config entry
PATCH
Env
Overview
List env entries
GET
Get one env entry
GET
Upsert an env entry
PUT
Delete an env entry
DELETE
Secrets
Overview
List secret metadata
GET
Create a secret or add a version
POST
Get secret metadata
GET
Revoke a secret
DELETE
List secret versions
GET
Get one secret-version record
GET
Rotate a secret (sync or async)
POST
Get async rotation status
GET
Subscribe to async rotation events (SSE)
GET
Schedules
List cron schedules
GET
Register a cron schedule
POST
Fetch a cron schedule
GET
Update a cron schedule
PATCH
Pause a cron schedule
POST
Resume a cron schedule
POST
Soft-delete a cron schedule (tombstone)
POST
Event triggers
List event triggers
GET
Register an event trigger
POST
Fetch an event trigger
GET
Update an event trigger
PATCH
Pause an event trigger
POST
Resume an event trigger
POST
Soft-delete an event trigger (tombstone)
POST
Webhooks
List webhook triggers
GET
Register a webhook trigger
POST
Fetch a webhook trigger
GET
Update a webhook trigger
PATCH
Pause a webhook trigger
POST
Resume a webhook trigger
POST
Soft-delete a webhook trigger (tombstone)
POST
Webhook endpoints
Overview
List webhook endpoints
GET
Register a webhook endpoint
POST
Generate a webhook signing secret
POST
Fetch a webhook endpoint
GET
Update a webhook endpoint
PATCH
Unregister a webhook endpoint (soft delete)
POST
List a webhook endpoint's deliveries
GET
Redeliver an event
POST
Send a test event to a webhook endpoint
POST
Webhooks
A top-level run completed, failed or was cancelled
POST
A test event sent on request (`POST /v1/webhook-endpoints/{endpointId}/test`)
POST
TypeScript
@kindgi/sdk
@kindgi/sdk/client
Classes
KindgiApiError
Interfaces
AdapterConfigureInput
AdapterFilter
AdaptersClient
AdapterTestInput
AgentsClient
ApplyProposalInput
ApprovalFilter
ApprovalsClient
ArtifactFilter
ArtifactsClient
AuditClient
AuditExportInput
AuthError
BatchDecideInput
BudgetsClient
CapabilitiesClient
CapabilityFilter
ClientOptions
CompleteTokenInput
ConflictError
ConversationFilter
ConversationsClient
CostClient
DecideInput
DraftProposalsInput
EventsClient
FactsClient
FlowFilter
FlowsClient
FlowValidateResult
FollowRunOptions
GuardrailFilter
GuardrailsClient
GuardrailViolation
GuardrailViolationError
InvalidRequestError
KindgiClient
ListTeamsFilter
LogsClient
McpClient
McpEndpointFilter
McpEndpointsClient
MemoryClient
MessageFilter
NetworkError
NotFoundError
NotImplementedInPreviewError
NotYetWiredError
ObservationFilter
ObservationsClient
OrgsClient
PackFilter
PacksClient
PageFilter
PatternsInput
PoliciesClient
PolicyListFilter
PolicyVersionsFilter
ProposalDryRunInput
ProposalListInput
ProposalsClient
ProvenanceClient
ProvenanceExportInput
ProviderFilter
ProvidersClient
RateLimitedError
ReflectReviewInput
RegistryClient
RegistryFilter
ReinstateToolVersionResult
ResumeRunInput
ReviewerFilter
ReviewersClient
RollbackProposalInput
Run
RunProgressEvent
RunsClient
SchedulesClient
ServerError
SessionsClient
SseEvent
SseReadOptions
SubmitForReviewInput
SubscribeToRunOptions
SubscriptionsClient
SupervisorClient
TeamMembershipsClient
TeamsClient
TenantClient
TenantConfigClient
TokenFilter
TokensClient
ToolFilter
ToolsClient
ToolVersionFilter
Transport
TransportRequest
UsageClient
UsageSummaryInput
UserFilter
UsersClient
WebhooksClient
WithdrawProposalInput
Type Aliases
AddMembershipInput
KindgiError
RunProgress
RunProgress
StartRunInput
Functions
createClient
followRun
fromWire
notImplementedInPreview
notYetWired
readSse
subscribeToRun
unwrapSseData
@kindgi/sdk/define
Interfaces
Agent
DefineAgentSpec
DefineCheckSpec
DefineToolSpec
EdgePolicy
FanoutNode
Flow
HttpHeaderSpec
HttpToolSpec
SubflowNode
Tool
ToolContext
ToolManifest
ToolSecretRef
ZodLikeSchema
Type Aliases
AnySchema
DefinedCheck
DefinedTool
FlowSpec
HttpAuthSpec
HttpMethod
HttpRequestBodySpec
InferCheckConfig
InferInput
InferOutput
LoopNode
ToolSpec
ToolSpecSynthesizer
Functions
defineAgent
defineCheck
defineFlow
defineTool
defineToolAsync
invokeTool
isZodSchema
registerToolSpecSynthesizer
toJSONSchema
@kindgi/sdk/types
Interfaces
BlobRef
DatasetRef
Filter
Page
VersionedRef
Type Aliases
AgentId
ApiTokenId
ApprovalId
ArtifactId
AuditBundleId
Brand
ComplianceEvidenceId
ContentHash
ConversationId
Cursor
DatasetId
DurationMs
EdgeId
ErrOf
EventId
FactId
FixProposalId
FlowId
GuardrailId
InstallationId
IsoDuration
KeyId
LogEntryId
NodeId
ObservationId
OkOf
OrgId
PackId
PolicyId
ProjectId
ProvenanceId
ProviderId
Result
ReviewerId
RunId
ScheduleId
SchemaMajor
Semver
SessionId
SignatureValue
SigningKeyId
SubscriptionId
SupervisorId
TeamId
TenantId
ThreadId
Timestamp
ToolId
TriggerId
UserId
WaitTokenId
WebhookDeliveryId
WebhookId
@kindgi/sdk/webhooks
Interfaces
SignWebhookInput
VerifyWebhookInput
Type Aliases
VerifyWebhookFailure
VerifyWebhookResult
WebhookRequestHeaders
Variables
DEFAULT_WEBHOOK_TOLERANCE_SECONDS
WEBHOOK_HEADERS
WEBHOOK_SECRET_MIN_BYTES
WEBHOOK_SECRET_PREFIX
Functions
generateWebhookSecret
isStrongWebhookSecret
signWebhook
verifyWebhook
webhookHeaders
Python
Overview
models
Overview
Models: A
Models: B
Models: C
Models: D
Models: E
Models: F
Models: G
Models: H
Models: I
Models: J
Models: L
Models: M
Models: N
Models: O
Models: P
Models: R
Models: S
Models: T
Models: U
Models: W
resources
Overview
client.adapters
client.agents
client.approvals
client.approvals.reviewers
client.artifacts
client.audit
client.audit.authz
client.auth
client.auth.providers
client.capabilities
client.compliance
client.compliance.evidence
client.conversations
client.cost
client.cost.records
client.deployments
client.env
client.eval_runs
client.eval_suites
client.eval_suites.versions
client.event_triggers
client.flows
client.guardrails
client.identity
client.identity.users
client.mcp
client.mcp.endpoints
client.mcp.endpoints.prompts
client.mcp.endpoints.resources
client.memory
client.observations
client.orgs
client.policies
client.policies.versions
client.projects
client.projects.memberships
client.proposals
client.provenance
client.providers
client.runs
client.schedules
client.secrets
client.signing_keys
client.system
client.teams
client.teams.memberships
client.tenant
client.tenant.config
client.tokens
client.tools
client.webhook_endpoints
client.webhooks
kindgi
kindgi.client
kindgi.webhooks
python -m kindgi.pack
CLI
Overview
kindgi auth
kindgi init
kindgi dev
kindgi build
kindgi deploy
kindgi test
kindgi env
kindgi secrets
kindgi key
kindgi mcp
kindgi mcp-launch
kindgi runs
kindgi agents
kindgi tools
kindgi guardrails
kindgi approvals
kindgi reviewers
kindgi providers
kindgi adapters
kindgi skills
kindgi feedback
kindgi health
kindgi version
Environment variables
Packages
Overview
@kindgi/adapter-model-anthropic
@kindgi/adapter-model-gemini
@kindgi/adapter-model-in-process
@kindgi/adapter-model-openai-compat
@kindgi/agents
@kindgi/api
@kindgi/audit-events
@kindgi/audit-events-inmemory
@kindgi/authz
@kindgi/blob-binding
@kindgi/capabilities
@kindgi/cli
@kindgi/compliance
@kindgi/crypto
@kindgi/dev-echo-provider
@kindgi/dotenv-file
@kindgi/embedding
@kindgi/env-inmemory
@kindgi/env-schema
@kindgi/flow
@kindgi/guardrails
@kindgi/handler
@kindgi/handler-runtime
@kindgi/memory
@kindgi/pack-conformance
@kindgi/platform
@kindgi/policy-contract
@kindgi/provenance
@kindgi/runtime
@kindgi/sandbox
@kindgi/schema
@kindgi/sdk
@kindgi/secrets-dotenv
@kindgi/specs
@kindgi/testing
@kindgi/tools
@kindgi/types
JSON Schemas
Overview
Agent
HITL audit bundle
Capability declaration
Compliance evidence bundle
Discoverable entity
Evaluation suite
Event
Flow
Guardrail
Memory — Log + Facts
Pack manifest
Pack index
Pack protocol
Tenant policy
Provenance DAG
Run event
Tool
Contributing
Overview
GitHub
Version
Select theme
Dark
Light
Auto
PackId
type
PackId
=
Brand
<
string
,
"
PackId
"
>;
A pack manifest (installable vertical application).