Skip to content
Katara documentation
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Start
Start chatting
Use the API
Set up a first agent
How it works
Models and bundles
Pricing and fees
Katara Cortex
Wallet and spending approval
Synapse and Locus
Synapse and Locus
Product availability
Tutorial: run a managed agent
Tutorial: act from your own runtime
Access and API keys
Service accounts
Agent identities
Define, test and inspect an agent
Watching a run
Content, collections and memory
Tools, policies and approvals
Connect a tool account
Authorize a tool account
Schedule agent runs
Signed event sources
Evaluation datasets, rubrics and assessments
Human approval for Test-to-Live promotion
Roll back a Live agent configuration
Product SDK examples
The product API with curl
Notifications
Organization statements
Support access
Closing an organization
Pay for runs from your wallet
Using Katara
The chat app
The command line
Providing inference
Providing inference
Hardware Compatibility
Running a node
Linux and Windows setup
Networking
Native Windows
Developers
Usage and cost
Errors
Tool calling
Pay per request with x402
Embeddings
Images
Inference API
Overview
Models
Overview
Read active provider offers
Check provider registration
List models
Chat
Overview
Create a chat completion
Embeddings
Overview
Create embeddings
Images
Overview
Generate an image
Responses
Overview
Create a response
Product API
Overview
Organizations
Overview
List your organizations
Create an organization with Test and Live environments
Read an organization you belong to
Check what a workflow still needs in an environment
List invitation metadata as an organization administrator
Invite a person by email address
Accept the exact reviewed invitation
Review a private organization invitation
Revoke an unaccepted invitation
List organization members
Change organization membership
Transfer organization ownership
List organization teams
Create an organization team
List the current membership of an organization team
Add or remove a team member
Read whether a key may pay for runs with x402
Allow or stop a key paying for runs with x402
Environments
Overview
List the organization Test and Live environments
Read current environment authority
Reset the reviewed Test environment
Service accounts
Overview
List organization service accounts
Create an organization service account
Change service-account authority and revoke affected keys
API keys
Overview
List key authority and metadata without secret hashes
Create an environment-bound API key with explicit product permissions
Revoke a key for subsequent requests
Organization sign-in
Overview
getOrganizationSessionEvidence
reviewOrganizationSession
getOrganizationSessionPolicy
configureOrganizationSessionPolicy
listOrganizationSessionPolicyOperations
Name the identity providers an organization signs in through
First-agent setup
Overview
Read the setup the caller has under way
Set up a first agent and start its first run
Read how far a setup has come
Discard a setup that has not reached its first run
Agent authority
Overview
Read agent authority metadata
Register an agent service-account identity
Change an agent identity and invalidate prior grants
Let an agent's runs take code and browser steps
Let an agent run
Read the executors declared for an agent identity
Declare the executor that may run an external agent's work
Revoke an external executor
Read agent authority metadata
Issue a grant bound to the payer funded budget
Delegate a narrower grant from a registered service key
Read agent authority metadata
Revoke a grant and subsequent child permission checks
Agent definitions
Overview
Resolve a current Cortex capability pin for selected models
List current models eligible for agent authoring
List pinned Test simulation fixtures
Read authorized agent execution metadata
Publish an immutable signed agent version
Read authorized agent execution metadata
Revoke the exact signed agent version
Get the latest immutable definition for an active managed agent
Runs
Overview
List private result metadata for one run
Inspect a private run result, including expiry and blocked state
Permanently block access to a run result
Download verified result bytes under current source and storage authority
Read authorized agent execution metadata
Admit a run against an immutable version and funded grant
Read authorized agent execution metadata
Request cancellation without clearing unresolved effects
Read the direct children admitted for an authorized run
Read what happened to a run's code and browser sandboxes
Read what a run has spent and holds
Watch a run, resuming from the last event seen
Read the canonical metadata trace for a run
Create an immutable trace metadata export
Read a trace export manifest
Read an ordered trace export page
Read trace retention and metadata availability
Schedules
Overview
getScheduleVersion
listSchedules
publishSchedule
setScheduleEnabled
retireSchedule
getSchedule
Event sources
Overview
Read exact signed-event receipt metadata
getEventSourceVersion
listEventSources
publishEventSource
setEventSourceEnabled
retireEventSource
getEventSource
Submit an externally signed source event
List signed-event receipt metadata
Content
Overview
Let an agent read what one of its versions pins
List currently authorized content metadata
Change a content object reader writer or reviewer
List explicit content sharing entries as its manager
Approve a candidate content version as its human owner
Read customer storage setup as an organization administrator
Prepare customer storage configuration in a signed-in session
Create a Katara-hosted content store as an owner or administrator
Read hosted storage use against the quota
Read customer storage setup as an organization administrator
Revoke a storage connection
Verify customer role key bucket and browser access
Permanently block content resolution with a tombstone
Export an object’s versions and policy
List content version metadata with write access
List an object's legal holds
Hold an object against destruction
Lift a legal hold
Extract bounded source-linked text from an approved file without persisting it
Download an approved current content version
Download the exact candidate content as its human owner
List currently authorized content metadata
Register a preconfigured customer content store
Revoke content store access
Create an immutable content upload intent
Verify uploaded bytes and create a candidate version
Issue a short lived upload grant for the exact content version
List blocked objects whose tombstones are kept
Collections
Overview
List accessible knowledge collections
Create a private knowledge collection
Read collection metadata
Read collection sharing settings
Change collection sharing at its current revision
Block a collection permanently
Rename a collection at its current revision
List currently authorized collection sources
Add or replace an approved source reference
Remove source membership from a collection
Move a collection's sources onto the versions their documents stand at now
Assemble the passages that answer a query within a model's token budget
Web sources
Overview
List registered sources
Register a permitted source
Read one registered source
Withdraw a source and its documents
Withdraw one document that has gone from the source
Re-state an expired or withdrawn approval
Fetch one approved document
Repositories
Overview
List the repositories this environment may answer from
Attach a repository the GitHub App installation reaches
Stop reading an attached repository and remove what was read
Approve an attached repository again for 30 days
Read an attached repository at its default branch's head
List the documents an attachment serves, with the commit each was read at
List the files the latest sync saw and did not read, and why
List the repositories an installation of the GitHub App reaches
List the GitHub App installations the organization reads through
Stop reading through a GitHub App installation
Start linking a GitHub login or installing the GitHub App
Finish a GitHub sign-in with what GitHub returned
Read your linked GitHub login
Unlink your GitHub login
Memory
Overview
Propose an immutable memory version with approved sources
Approve an owned candidate as the next canonical fact version
Tombstone the fact after checking its latest version
Read current approved fact metadata after source checks
Inspect an owned fact version after source checks
List authorized current facts or owned candidates
Download the approved fact value after all source checks
Download the owned candidate value for human review
Budgets
Overview
Read funded budgets in an environment
Reserve existing credits for an environment budget
Read an environment budget and its held funds
Release unused funding after all exposure is resolved
Read the signed-in payer’s consents for the current environment generation
Authorize an explicit payer limit
Revoke payer consent for new work
Tools
Overview
Read authorized tool catalog metadata
Inspect endpoint ownership setup and state
Prepare a self-hosted endpoint ownership challenge
Inspect endpoint ownership setup and state
Revoke an endpoint binding
Verify the expected endpoint ownership proof
Compile a selected operation from an approved API document for review
Read authorized tool catalog metadata
Publish a tool version without enabling execution
Read authorized tool catalog metadata
Disable the expected tool activation
Enable a verified tool version with a recent administrator sign-in
Revoke an immutable tool version
Check whether a tool version's endpoint still serves what was published
Read authorized tool catalog metadata
Tool credentials
Overview
List visible tool credential connections
Connect a reviewed tool account
Read a tool credential connection
Reconnect the same verified tool account
Revoke a tool credential connection
Begin a reviewed OAuth authorization
Inspect OAuth authorization status
Activate a reviewed OAuth account
Complete a one-time OAuth exchange
List enrolled OAuth profiles
Ensure current OAuth access for the exact credential
Preview a verified tool account
List enrolled tool credential profiles
Read an immutable tool credential version
Policies
Overview
Read signed policy metadata
Publish a signed immutable policy version
Read signed policy metadata
Run the fixed policy regression checks
Decide recorded actions again under a policy before activating it
Revoke a policy and its inherited authority
Activate a reviewed policy in a signed-in human session
Read signed policy metadata
Read signed policy metadata
Approvals
Overview
List actions with current approval authority
Read the bound action and current approval stages
Approve or deny the exact action as an eligible verified person
Read the exact authorized text input for a current approval
Actions
Overview
List your Locus actions
Admit a governed action for an external runtime and run it
Ask what admission would decide for an action
Inspect a Locus action
Read an action's reconciliation
Record what happened to an action whose outcome is unknown
Evaluation material
Overview
List accessible latest dataset versions
Publish an immutable dataset version
List accessible dataset history
Read an exact dataset version
Revoke an exact dataset version
List accessible latest rubric versions
Publish an immutable rubric version
Read a registered quality bar
Register the quality bar a rubric's promotions must clear
Summarise how judging against a rubric has gone and what it cost
List accessible rubric history
Read an exact rubric version
Preview exact rubric criteria
Record human review of exact rubric criteria
Revoke an exact rubric version
Evaluation assessments
Overview
List current authorized assessments
Admit one funded evaluation case
Read the pinned judge profile
Read a current authorized evaluation assessment
Read a canonical uncalibrated score
Evaluation calibration
Overview
Read the current blinded assignment
Read one exact assigned content part
Submit an immutable blinded human label
Read an immutable uncalibrated certificate
Compare paired outputs or judges
Read the immutable paired comparison
List the campaigns you created
Create an immutable held-out campaign
Read a campaign as its creator
Assign the next independent blinded review
Seal current complete human and judge evidence
List your open review assignments
Online evaluation
Overview
Read an agent's sampling settings
Record whether sampled live runs are judged for an agent
Promotion evidence
Overview
List owner-visible evidence declarations
Declare a human quality policy
Read an immutable evidence declaration
List owner-visible evidence previews
Prepare all-case promotion evidence
Read an immutable evidence preview
List owner-visible evidence receipts
Approve an exact evidence preview
Read an immutable evidence receipt
Environment promotion
Overview
List owner-created promotion drafts
Create an immutable promotion draft
Read a promotion draft
Prepare an exact promotion review
Read a current promotion review
Publish the exact reviewed Live version
Read historical promotion receipt
Agent rollback
Overview
List rollback reviews
Review an exact prior Live configuration
Read a rollback review
Activate the exact reviewed rollback
Read a rollback activation receipt
Reconciliation and holds
Overview
List runs and actions awaiting reconciliation
Read a run's reconciliation
Record the resolution of a run's reconciliation
List legal and security holds
Hold a run's recovery checkpoint
Release a hold
Access reviews
Overview
List the environment's access reviews
Open a review and freeze who holds what
Read the recorded review cadence
Record how often access is reviewed
Read a review and how much of it is answered
Close a review once its removals are done
Answer one entry of an open review
Read the frozen entries a review is answering
Read what was decided for removal and still holds access
Audit
Overview
List recorded administration operations
Seal the audit directory for handing over
Read a sealed snapshot's manifest
Read the sealed rows of a snapshot
Support access
Overview
List support access granted to your own account's notices
List what was done under one support access grant on your account
End a support access grant on your account
List support access granted to this environment
List what was done under one support access grant
End a support access grant
Statements and billing
Overview
Read the paid-tool providers an environment has enrolled
Read what an environment bought from one paid-tool provider
Read what an organization was charged in a period
List the billing periods this organization has been billed for
Organization closure
Overview
Close the organization
Read how far the organization's closure has come
Notifications
Overview
Account-wide getNotificationPushOperation
Account-wide listNotificationPushSubscriptions
Account-wide registerNotificationPushSubscription
Account-wide getNotificationPushSubscription
Account-wide revokeNotificationPushSubscription
getNotificationPushConfiguration
getNotificationPushOperation
listNotificationPushSubscriptions
registerNotificationPushSubscription
getNotificationPushSubscription
revokeNotificationPushSubscription
reviewNotificationRecovery
redeliverNotification
getNotificationRecoveryReceipt
List dead-lettered deliveries to recover
List your notifications
Count unread notifications
Read the notification catalog
Read your notification preferences
Set a notification preference
Read a notification
Change notification read state
Read notification delivery status
List your webhook subscriptions
Create a webhook ownership challenge
Read webhook setup
Verify webhook endpoint ownership
Activate the reviewed webhook
Revoke a webhook and its signing keys
Rotate the webhook signing key
About
What Katara does not do
Networks
GitHub
Select theme
Dark
Light
Auto
Overview
Content
Section titled “Content”
Content in the selected Katara account or environment.
Operations
Section titled “Operations”
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/agent-identities/{id}/content-access
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/access
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/access/list
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/approve
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/connections
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/connections
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/hosted-stores
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/storage-usage
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/connections/{id}
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/connections/{id}/revoke
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/connections/{id}/verify
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/delete
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/exports
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/history
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/holds
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/holds
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/holds/release
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/parse
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/read
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/review
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/stores
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/stores
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/stores/{id}/revoke
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/uploads
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/uploads/complete
POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/uploads/grant
GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/content/blocked
