# Product API operation index

> Synapse, Locus and shared account operations, generated from the product OpenAPI spec.

Section: Product API. Web page: https://docs.staging.katara.com/product-api/

Synapse, Locus and shared account APIs. Which operations answer depends on the services enabled in the deployment you call and on the product access your environment holds. Run admission does not guarantee that execution has started or completed. Read [Product availability](https://docs.staging.katara.com/products/availability.txt) before integrating.

Product routes start at `https://api.staging.katara.com/katara/v1`. Each group below lists its operations with the credential they take and a link to the full reference; the complete schemas are in https://docs.staging.katara.com/katara-products.yaml. Start with the guide for a task, listed in https://docs.staging.katara.com/llms.txt, rather than with this list.

"API key or signed-in person" still needs the key's scopes; "signed-in person only" means a person's session must make the call, so an agent cannot.

- [Organizations](https://docs.staging.katara.com/product-api/organizations.txt): listOrganizations, createOrganization, getOrganization, getEnvironmentPreflight, createInvitation, listInvitations, acceptInvitation, reviewInvitation, revokeInvitation, listMembers, changeMembership, transferOwnership, createTeam, listTeams, setTeamMembership, listTeamMembers, getKeyX402, setKeyX402
- [Environments](https://docs.staging.katara.com/product-api/environments.txt): listEnvironments, getEnvironment, resetEnvironment
- [Service accounts](https://docs.staging.katara.com/product-api/service-accounts.txt): createServiceAccount, listServiceAccounts, changeServiceAccount
- [API keys](https://docs.staging.katara.com/product-api/api-keys.txt): listKeys, createKey, revokeKey
- [Organization sign-in](https://docs.staging.katara.com/product-api/organization-sign-in.txt): getOrganizationSessionEvidence, reviewOrganizationSession, getOrganizationSessionPolicy, configureOrganizationSessionPolicy, listOrganizationSessionPolicyOperations, getOrganizationSignIn
- [First-agent setup](https://docs.staging.katara.com/product-api/first-agent-setup.txt): getCurrentSetup, startSetup, getSetup, discardSetup
- [Agent authority](https://docs.staging.katara.com/product-api/agent-authority.txt): createAgentIdentity, listAgentIdentities, changeAgentIdentity, enableSandboxAccess, allowAgentRuns, listExternalExecutors, declareExternalExecutor, revokeExternalExecutor, issueGrant, listGrants, delegateGrant, getGrant, revokeGrant
- [Agent definitions](https://docs.staging.katara.com/product-api/agent-definitions.txt): resolveAgentModelPolicy, listAgentModels, listSimulationFixtures, publishAgentVersion, listAgentVersions, getAgentVersion, revokeAgentVersion, getAgentDefinitionState
- [Runs](https://docs.staging.katara.com/product-api/runs.txt): listRunArtifacts, getRunArtifact, blockRunArtifact, readRunArtifact, createRun, listRuns, getRun, cancelRun, listRunChildren, listRunSandboxEvents, getRunCharges, runEvents, getRunTrace, createRunTraceExport, getRunTraceExport, getRunTraceExportPage, getRunTraceRetention
- [Schedules](https://docs.staging.katara.com/product-api/schedules.txt): getScheduleVersion, publishSchedule, listSchedules, setScheduleEnabled, retireSchedule, getSchedule
- [Event sources](https://docs.staging.katara.com/product-api/event-sources.txt): getEventSourceReceipt, getEventSourceVersion, publishEventSource, listEventSources, setEventSourceEnabled, retireEventSource, getEventSource, submitSignedSourceEvent, listEventSourceReceipts
- [Content](https://docs.staging.katara.com/product-api/content.txt): enableContentAccess, listContent, changeContentAccess, listContentAccess, approveContent, prepareContentConnection, listContentConnections, createHostedStore, getStorageUsage, getContentConnection, revokeContentConnection, verifyContentConnection, deleteContent, createContentExport, contentHistory, listContentLegalHolds, placeContentLegalHold, releaseContentLegalHold, parseContent, readContent, reviewContent, registerContentStore, listContentStores, revokeContentStore, beginContentUpload, completeContentUpload, issueContentUpload, listBlockedContent
- [Collections](https://docs.staging.katara.com/product-api/collections.txt): createCollection, listCollections, getCollection, listCollectionAccess, changeCollectionAccess, deleteCollection, renameCollection, putCollectionSource, listCollectionSources, removeCollectionSource, resyncCollectionSources, assembleContext
- [Web sources](https://docs.staging.katara.com/product-api/web-sources.txt): registerSource, listSources, getSource, revokeSource, deleteSourceDocument, reconnectSource, syncSource
- [Repositories](https://docs.staging.katara.com/product-api/repositories.txt): listRepositories, attachRepository, detachRepository, renewRepository, syncRepository, listRepositoryFiles, listRepositorySkips, listGitHubRepositories, listGitHubInstallations, unlinkGitHubInstallation, beginGitHubAuthorization, completeGitHubAuthorization, getGitHubLogin, unlinkGitHubLogin
- [Memory](https://docs.staging.katara.com/product-api/memory.txt): proposeMemory, approveMemory, deleteMemory, getMemory, inspectMemory, listMemory, readMemory, reviewMemory
- [Budgets](https://docs.staging.katara.com/product-api/budgets.txt): fundBudget, listBudgets, getBudget, closeBudget, createPayerConsent, listPayerConsents, revokePayerConsent
- [Tools](https://docs.staging.katara.com/product-api/tools.txt): discoverTools, createToolEndpoint, listToolEndpoints, getToolEndpoint, revokeToolEndpoint, verifyToolEndpoint, compileOpenAPI, publishToolVersion, listToolVersions, getToolVersion, disableToolVersion, enableToolVersion, revokeToolVersion, checkToolHealth, getToolState
- [Tool credentials](https://docs.staging.katara.com/product-api/tool-credentials.txt): connectToolCredential, listToolCredentialConnections, getToolCredentialConnection, reconnectToolCredential, revokeToolCredential, beginToolOAuthAuthorization, reviewToolOAuthAuthorization, activateToolOAuthAuthorization, completeToolOAuthAuthorization, listToolOAuthProfiles, refreshToolCredentialOAuth, previewToolCredentialAccount, listToolCredentialProfiles, getToolCredentialVersion
- [Policies](https://docs.staging.katara.com/product-api/policies.txt): publishPolicy, listPolicies, getPolicy, reviewPolicy, simulatePolicy, revokePolicy, activatePolicy, getPolicyReview, getPolicyState
- [Approvals](https://docs.staging.katara.com/product-api/approvals.txt): listApprovals, getApproval, decideApproval, previewApprovalInput
- [Actions](https://docs.staging.katara.com/product-api/actions.txt): listActions, submitAction, authorizeAction, getAction, getActionReconciliation, resolveActionReconciliation
- [Evaluation material](https://docs.staging.katara.com/product-api/evaluation-material.txt): publishEvaluationDatasetVersion, listEvaluationDatasets, listEvaluationDatasetVersions, getEvaluationDatasetVersion, revokeEvaluationDatasetVersion, publishEvaluationRubricVersion, listEvaluationRubrics, recordRubricThresholds, rubricThresholds, evaluationSummary, listEvaluationRubricVersions, getEvaluationRubricVersion, previewRubric, reviewRubric, revokeEvaluationRubricVersion
- [Evaluation assessments](https://docs.staging.katara.com/product-api/evaluation-assessments.txt): createEvaluationAssessment, listEvaluationAssessments, getEvaluationJudgeProfile, getEvaluationAssessment, getEvaluationAssessmentScore
- [Evaluation calibration](https://docs.staging.katara.com/product-api/evaluation-calibration.txt): getEvaluationCalibrationAssignment, getEvaluationCalibrationAssignmentContent, submitEvaluationCalibrationLabels, getEvaluationCalibrationCertificate, compareEvaluationCalibration, getEvaluationCalibrationComparison, createEvaluationCalibration, listEvaluationCalibrations, getEvaluationCalibration, assignEvaluationCalibration, sealEvaluationCalibration, listEvaluationCalibrationAssignments
- [Online evaluation](https://docs.staging.katara.com/product-api/online-evaluation.txt): setOnlineEvaluation, onlineEvaluation
- [Promotion evidence](https://docs.staging.katara.com/product-api/promotion-evidence.txt): declarePromotionEvidence, listPromotionEvidenceDeclarations, getPromotionEvidenceDeclaration, preparePromotionEvidence, listPromotionEvidencePreviews, getPromotionEvidencePreview, approvePromotionEvidence, listPromotionEvidenceReceipts, getPromotionEvidenceReceipt
- [Environment promotion](https://docs.staging.katara.com/product-api/environment-promotion.txt): createEnvironmentPromotion, listEnvironmentPromotions, getEnvironmentPromotion, reviewEnvironmentPromotion, getEnvironmentPromotionReview, activateEnvironmentPromotion, getEnvironmentPromotionReceipt
- [Agent rollback](https://docs.staging.katara.com/product-api/agent-rollback.txt): reviewAgentRollback, listAgentRollbackReviews, getAgentRollbackReview, activateAgentRollback, getAgentRollbackReceipt
- [Reconciliation and holds](https://docs.staging.katara.com/product-api/reconciliation-and-holds.txt): listReconciliations, getReconciliation, resolveReconciliation, listSandboxHolds, placeSandboxHold, releaseSandboxHold
- [Access reviews](https://docs.staging.katara.com/product-api/access-reviews.txt): openAccessReview, listAccessReviews, setAccessReviewPolicy, accessReviewPolicy, accessReview, closeAccessReview, decideAccessReview, accessReviewItems, accessReviewOutstanding
- [Audit](https://docs.staging.katara.com/product-api/audit.txt): listAuditOperations, createAuditExport, getAuditExport, readAuditExport
- [Support access](https://docs.staging.katara.com/product-api/support-access.txt): listAccountSupportAccess, listAccountSupportAccessUses, revokeAccountSupportAccess, listSupportAccess, listSupportAccessUses, revokeSupportAccess
- [Statements and billing](https://docs.staging.katara.com/product-api/statements-and-billing.txt): listPaidProviders, getPaidProviderReport, organizationStatement, listSubscriptionCycles
- [Organization closure](https://docs.staging.katara.com/product-api/organization-closure.txt): closeOrganization, getOrganizationClosure
- [Notifications](https://docs.staging.katara.com/product-api/notifications.txt): account_getNotificationPushOperation, account_listNotificationPushSubscriptions, account_registerNotificationPushSubscription, account_getNotificationPushSubscription, account_revokeNotificationPushSubscription, getNotificationPushConfiguration, getNotificationPushOperation, listNotificationPushSubscriptions, registerNotificationPushSubscription, getNotificationPushSubscription, revokeNotificationPushSubscription, reviewNotificationRecovery, redeliverNotification, getNotificationRecoveryReceipt, listNotificationRecoveryDeliveries, listNotifications, countNotifications, notificationCatalog, notificationPreferences, setNotificationPreference, getNotification, setNotificationState, notificationDeliveries, listNotificationWebhooks, createNotificationWebhook, getNotificationWebhook, verifyNotificationWebhook, reviewNotificationWebhook, revokeNotificationWebhook, rotateNotificationWebhook