# Kodexa Developer Portal

## Docs

- [Create AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/create-accesstoken.md): Creates a new AccessToken. Access tokens provide programmatic API authentication.
- [Delete AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/delete-access-tokens-id.md): Permanently deletes the specified AccessToken. Access tokens provide programmatic API authentication.
- [Delete AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/delete-accesstoken.md): Permanently deletes the specified AccessToken. Access tokens provide programmatic API authentication.
- [List AccessTokens](https://developer.kodexa.ai/api-reference/accesstokens/get-access-tokens.md): Returns a paginated list of AccessTokens. Access tokens provide programmatic API authentication.
- [Get AccessToken by ID](https://developer.kodexa.ai/api-reference/accesstokens/get-access-tokens-id.md): Retrieves a single AccessToken by its unique identifier. Access tokens provide programmatic API authentication.
- [Get AccessToken change sequence](https://developer.kodexa.ai/api-reference/accesstokens/get-access-tokens-id-sequence.md): Returns the current change sequence number for the specified AccessToken. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get AccessToken by ID](https://developer.kodexa.ai/api-reference/accesstokens/get-accesstoken-by-id.md): Retrieves a single AccessToken by its unique identifier. Access tokens provide programmatic API authentication.
- [Get AccessToken change sequence](https://developer.kodexa.ai/api-reference/accesstokens/get-accesstoken-change-sequence.md): Returns the current change sequence number for the specified AccessToken. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List AccessTokens](https://developer.kodexa.ai/api-reference/accesstokens/list-accesstokens.md): Returns a paginated list of AccessTokens. Access tokens provide programmatic API authentication.
- [Create AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/post-access-tokens.md): Creates a new AccessToken. Access tokens provide programmatic API authentication.
- [Update AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/put-access-tokens-id.md): Updates an existing AccessToken. Access tokens provide programmatic API authentication.
- [Update AccessToken](https://developer.kodexa.ai/api-reference/accesstokens/update-accesstoken.md): Updates an existing AccessToken. Access tokens provide programmatic API authentication.
- [Accept platform terms](https://developer.kodexa.ai/api-reference/account/accept-platform-terms.md)
- [Auth0 profile sync callback](https://developer.kodexa.ai/api-reference/account/auth0-profile-sync-callback.md): Receives an Auth0 callback to synchronise the authenticated user's profile data on the platform.
- [Check if user is admin](https://developer.kodexa.ai/api-reference/account/check-if-user-is-admin.md): Returns whether the currently authenticated user has platform admin privileges.
- [Create CLI access token](https://developer.kodexa.ai/api-reference/account/create-cli-access-token.md): Creates a new access token for CLI authentication. The returned token can be used for subsequent API calls.
- [Check if user is admin](https://developer.kodexa.ai/api-reference/account/get-account-admin.md): Returns whether the currently authenticated user has platform admin privileges.
- [Get current user](https://developer.kodexa.ai/api-reference/account/get-account-me.md): Returns the profile and settings of the currently authenticated user.
- [Get account memberships (legacy alias)](https://developer.kodexa.ai/api-reference/account/get-account-memberships.md): Legacy alias of GET /account/teams retained for cached UI bundles.
- [Get account memberships (legacy alias)](https://developer.kodexa.ai/api-reference/account/get-account-memberships-legacy-alias.md): Legacy alias of GET /account/teams retained for cached UI bundles.
- [Get account organization access](https://developer.kodexa.ai/api-reference/account/get-account-organization-access.md): Returns all team-based organization access for the currently authenticated user.
- [List FGAC permissions for the current user](https://developer.kodexa.ai/api-reference/account/get-account-permissions.md): Returns the fine-grained access control (FGAC) permissions granted to the currently authenticated user across organizations and resources.
- [Get account organization access](https://developer.kodexa.ai/api-reference/account/get-account-teams.md): Returns all team-based organization access for the currently authenticated user.
- [Get current user](https://developer.kodexa.ai/api-reference/account/get-current-user.md): Returns the profile and settings of the currently authenticated user.
- [List FGAC permissions for the current user](https://developer.kodexa.ai/api-reference/account/list-fgac-permissions-for-the-current-user.md)
- [Auth0 profile sync callback](https://developer.kodexa.ai/api-reference/account/post-account-callback.md): Receives an Auth0 callback to synchronise the authenticated user's profile data on the platform.
- [Create CLI access token](https://developer.kodexa.ai/api-reference/account/post-account-cli-access-token.md): Creates a new access token for CLI authentication. The returned token can be used for subsequent API calls.
- [Verify CLI device code](https://developer.kodexa.ai/api-reference/account/post-account-cli-device-verify.md): Verifies a CLI device code to complete the device authorization flow. Used by the Kodexa CLI to authenticate users via browser-based login.
- [Accept platform terms](https://developer.kodexa.ai/api-reference/account/put-account-acceptTerms.md): Records the current user's acceptance of the Kodexa platform terms and conditions, completing onboarding and unlocking full API access.
- [Update current user](https://developer.kodexa.ai/api-reference/account/put-account-me.md): Updates the profile and settings of the currently authenticated user.
- [Update current user](https://developer.kodexa.ai/api-reference/account/update-current-user.md): Updates the profile and settings of the currently authenticated user.
- [Verify CLI device code](https://developer.kodexa.ai/api-reference/account/verify-cli-device-code.md): Verifies a CLI device code to complete the device authorization flow. Used by the Kodexa CLI to authenticate users via browser-based login.
- [Approve a paused activity step](https://developer.kodexa.ai/api-reference/activities/approve-a-paused-activity-step.md): Approves a step that paused for human review and lets the activity continue.
- [Cancel a running activity](https://developer.kodexa.ai/api-reference/activities/cancel-a-running-activity.md)
- [Delete Activity](https://developer.kodexa.ai/api-reference/activities/delete-activities-id.md): Permanently deletes the specified Activity. Activities are runtime instances of an ActivityPlan, materialized into a graph of Steps.
- [Delete Activity](https://developer.kodexa.ai/api-reference/activities/delete-activity.md): Permanently deletes the specified Activity. Activities are runtime instances of an ActivityPlan, materialized into a graph of Steps.
- [List Activities](https://developer.kodexa.ai/api-reference/activities/get-activities.md): Returns a paginated list of Activities. Activities are runtime instances of an ActivityPlan, materialized into a graph of Steps.
- [Get Activity by ID](https://developer.kodexa.ai/api-reference/activities/get-activities-id.md): Retrieves a single Activity by its unique identifier. The response embeds the activity's steps (ordered by sequence ascending) so a single round-trip suffices — collapses the legacy `GET /api/plans/{id}` + `GET /api/plans/{id}/items` pair.
- [Get activity logs](https://developer.kodexa.ai/api-reference/activities/get-activities-id-logs.md): Returns aggregated log output from every step of the activity.
- [Get Activity change sequence](https://developer.kodexa.ai/api-reference/activities/get-activities-id-sequence.md): Returns the current change sequence number for the specified Activity. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List document family executions for an activity step](https://developer.kodexa.ai/api-reference/activities/get-activities-id-steps-stepId-document-families.md): Returns one row per document family processed by the specified step, including the input/output content object IDs and any error details. Used by the per-step debug panel.
- [Get Activity by ID](https://developer.kodexa.ai/api-reference/activities/get-activity-by-id.md): Retrieves a single Activity by its unique identifier. The response embeds the activity's steps (ordered by sequence ascending) so a single round-trip suffices — collapses the legacy `GET /api/plans/{id}` + `GET /api/plans/{id}/items` pair.
- [Get Activity change sequence](https://developer.kodexa.ai/api-reference/activities/get-activity-change-sequence.md): Returns the current change sequence number for the specified Activity. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get activity logs](https://developer.kodexa.ai/api-reference/activities/get-activity-logs.md): Returns aggregated log output from every step of the activity.
- [List Activities](https://developer.kodexa.ai/api-reference/activities/list-activities.md): Returns a paginated list of Activities. Activities are runtime instances of an ActivityPlan, materialized into a graph of Steps.
- [List document family executions for an activity step](https://developer.kodexa.ai/api-reference/activities/list-document-family-executions-for-an-activity-step.md): Returns one row per document family processed by the specified step, including the input/output content object IDs and any error details. Used by the per-step debug panel.
- [Start an activity](https://developer.kodexa.ai/api-reference/activities/post-activities.md): Creates and starts a new Activity from an ActivityPlan. Returns the materialised Activity with its initial Step graph.
- [Cancel a running activity](https://developer.kodexa.ai/api-reference/activities/post-activities-id-cancel.md): Cancels a running Activity by ID, halting its remaining steps and marking the activity instance as cancelled in the Kodexa platform.
- [Replan an activity](https://developer.kodexa.ai/api-reference/activities/post-activities-id-replan.md): Creates a new instance of the activity using the same plan, inputs, and trigger metadata; marks the source activity as REPLANNED.
- [Retry a failed activity](https://developer.kodexa.ai/api-reference/activities/post-activities-id-retry.md): Retries a previously failed Activity by ID, re-running its failed steps so the business process can resume from where it last stopped.
- [Approve a paused activity step](https://developer.kodexa.ai/api-reference/activities/post-activities-id-steps-stepId-approve.md): Approves a step that paused for human review and lets the activity continue.
- [Replan an activity](https://developer.kodexa.ai/api-reference/activities/replan-an-activity.md): Creates a new instance of the activity using the same plan, inputs, and trigger metadata; marks the source activity as REPLANNED.
- [Retry a failed activity](https://developer.kodexa.ai/api-reference/activities/retry-a-failed-activity.md)
- [Start an activity](https://developer.kodexa.ai/api-reference/activities/start-an-activity.md): Creates and starts a new Activity from an ActivityPlan. Returns the materialised Activity with its initial Step graph.
- [Update an activity step](https://developer.kodexa.ai/api-reference/activities/update-an-activity-step.md): Patches a single step on an activity. Whitelist: only `scriptBody` is writable, and only on SCRIPT-kind steps — non-SCRIPT kinds return 400. Unknown fields are silently ignored for legacy parity.
- [List ActivityDocumentFamilies](https://developer.kodexa.ai/api-reference/activitydocumentfamilies/get-activity-document-families.md): Returns a paginated list of ActivityDocumentFamilies. Links between activities and document families.
- [Get ActivityDocumentFamily change sequence](https://developer.kodexa.ai/api-reference/activitydocumentfamilies/get-activity-document-families-id-sequence.md): Returns the current change sequence number for the specified ActivityDocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ActivityDocumentFamily change sequence](https://developer.kodexa.ai/api-reference/activitydocumentfamilies/get-activitydocumentfamily-change-sequence.md): Returns the current change sequence number for the specified ActivityDocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List ActivityDocumentFamilies](https://developer.kodexa.ai/api-reference/activitydocumentfamilies/list-activitydocumentfamilies.md): Returns a paginated list of ActivityDocumentFamilies. Links between activities and document families.
- [Create ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/create-activityplan.md): Creates a new ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Delete ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/delete-activity-plans-id.md): Permanently deletes the specified ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Delete ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/delete-activityplan.md): Permanently deletes the specified ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [List ActivityPlans](https://developer.kodexa.ai/api-reference/activityplans/get-activity-plans.md): Returns a paginated list of ActivityPlans. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Get ActivityPlan by ID](https://developer.kodexa.ai/api-reference/activityplans/get-activity-plans-id.md): Retrieves a single ActivityPlan by its unique identifier. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Get ActivityPlan change sequence](https://developer.kodexa.ai/api-reference/activityplans/get-activity-plans-id-sequence.md): Returns the current change sequence number for the specified ActivityPlan. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ActivityPlan by ID](https://developer.kodexa.ai/api-reference/activityplans/get-activityplan-by-id.md): Retrieves a single ActivityPlan by its unique identifier. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Get ActivityPlan change sequence](https://developer.kodexa.ai/api-reference/activityplans/get-activityplan-change-sequence.md): Returns the current change sequence number for the specified ActivityPlan. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List ActivityPlans](https://developer.kodexa.ai/api-reference/activityplans/list-activityplans.md): Returns a paginated list of ActivityPlans. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Create ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/post-activity-plans.md): Creates a new ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Update ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/put-activity-plans-id.md): Updates an existing ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Update ActivityPlan](https://developer.kodexa.ai/api-reference/activityplans/update-activityplan.md): Updates an existing ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
- [Create OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/create-orchestratoragentruntime.md): Creates a new OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Delete OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/delete-agent-runtimes-id.md): Permanently deletes the specified OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Delete OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/delete-orchestratoragentruntime.md): Permanently deletes the specified OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [List Agent Runtimes](https://developer.kodexa.ai/api-reference/agent-runtimes/get-agent-runtimes.md): Returns a paginated list of Agent Runtimes. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Get OrchestratorAgentRuntime by ID](https://developer.kodexa.ai/api-reference/agent-runtimes/get-agent-runtimes-id.md): Retrieves a single OrchestratorAgentRuntime by its unique identifier. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Get OrchestratorAgentRuntime change sequence](https://developer.kodexa.ai/api-reference/agent-runtimes/get-agent-runtimes-id-sequence.md): Returns the current change sequence number for the specified OrchestratorAgentRuntime. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get OrchestratorAgentRuntime by ID](https://developer.kodexa.ai/api-reference/agent-runtimes/get-orchestratoragentruntime-by-id.md): Retrieves a single OrchestratorAgentRuntime by its unique identifier. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Get OrchestratorAgentRuntime change sequence](https://developer.kodexa.ai/api-reference/agent-runtimes/get-orchestratoragentruntime-change-sequence.md): Returns the current change sequence number for the specified OrchestratorAgentRuntime. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Agent Runtimes](https://developer.kodexa.ai/api-reference/agent-runtimes/list-agent-runtimes.md): Returns a paginated list of Agent Runtimes. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Create OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/post-agent-runtimes.md): Creates a new OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Update OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/put-agent-runtimes-id.md): Updates an existing OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Update OrchestratorAgentRuntime](https://developer.kodexa.ai/api-reference/agent-runtimes/update-orchestratoragentruntime.md): Updates an existing OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
- [Create OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/create-orchestratoragentsession.md): Creates a new OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [Delete OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/delete-agent-sessions-id.md): Permanently deletes the specified OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [Delete OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/delete-orchestratoragentsession.md): Permanently deletes the specified OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [List Agent Sessions](https://developer.kodexa.ai/api-reference/agent-sessions/get-agent-sessions.md): Returns a paginated list of Agent Sessions. Agent sessions track stateful conversation sessions within agent runtimes.
- [Get OrchestratorAgentSession by ID](https://developer.kodexa.ai/api-reference/agent-sessions/get-agent-sessions-id.md): Retrieves a single OrchestratorAgentSession by its unique identifier. Agent sessions track stateful conversation sessions within agent runtimes.
- [Get OrchestratorAgentSession change sequence](https://developer.kodexa.ai/api-reference/agent-sessions/get-agent-sessions-id-sequence.md): Returns the current change sequence number for the specified OrchestratorAgentSession. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get OrchestratorAgentSession by ID](https://developer.kodexa.ai/api-reference/agent-sessions/get-orchestratoragentsession-by-id.md): Retrieves a single OrchestratorAgentSession by its unique identifier. Agent sessions track stateful conversation sessions within agent runtimes.
- [Get OrchestratorAgentSession change sequence](https://developer.kodexa.ai/api-reference/agent-sessions/get-orchestratoragentsession-change-sequence.md): Returns the current change sequence number for the specified OrchestratorAgentSession. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Agent Sessions](https://developer.kodexa.ai/api-reference/agent-sessions/list-agent-sessions.md): Returns a paginated list of Agent Sessions. Agent sessions track stateful conversation sessions within agent runtimes.
- [Create OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/post-agent-sessions.md): Creates a new OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [Update OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/put-agent-sessions-id.md): Updates an existing OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [Update OrchestratorAgentSession](https://developer.kodexa.ai/api-reference/agent-sessions/update-orchestratoragentsession.md): Updates an existing OrchestratorAgentSession. Agent sessions track stateful conversation sessions within agent runtimes.
- [Create OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/create-orchestratoragent.md): Creates a new OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Delete OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/delete-agents-id.md): Permanently deletes the specified OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Delete OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/delete-orchestratoragent.md): Permanently deletes the specified OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [List Agents](https://developer.kodexa.ai/api-reference/agents/get-agents.md): Returns a paginated list of Agents. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Get OrchestratorAgent by ID](https://developer.kodexa.ai/api-reference/agents/get-agents-id.md): Retrieves a single OrchestratorAgent by its unique identifier. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Get OrchestratorAgent change sequence](https://developer.kodexa.ai/api-reference/agents/get-agents-id-sequence.md): Returns the current change sequence number for the specified OrchestratorAgent. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get OrchestratorAgent by ID](https://developer.kodexa.ai/api-reference/agents/get-orchestratoragent-by-id.md): Retrieves a single OrchestratorAgent by its unique identifier. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Get OrchestratorAgent change sequence](https://developer.kodexa.ai/api-reference/agents/get-orchestratoragent-change-sequence.md): Returns the current change sequence number for the specified OrchestratorAgent. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Agents](https://developer.kodexa.ai/api-reference/agents/list-agents.md): Returns a paginated list of Agents. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Create OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/post-agents.md): Creates a new OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Update OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/put-agents-id.md): Updates an existing OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Update OrchestratorAgent](https://developer.kodexa.ai/api-reference/agents/update-orchestratoragent.md): Updates an existing OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
- [Create chat completion](https://developer.kodexa.ai/api-reference/ai-gateway/create-chat-completion.md): Creates a chat completion using the specified model via the AI Gateway. Supports both synchronous and streaming (SSE) responses. Set `stream: true` in the request body to receive server-sent events. The request is proxied to the organization's configured AI provider (Bedrock, Azure, Gemini, etc.).
- [List available AI models](https://developer.kodexa.ai/api-reference/ai-gateway/get-organizations-orgId-ai-models.md): Returns the list of models available through the AI Gateway for the specified organization.
- [List available AI models](https://developer.kodexa.ai/api-reference/ai-gateway/list-available-ai-models.md): Returns the list of models available through the AI Gateway for the specified organization.
- [Create chat completion](https://developer.kodexa.ai/api-reference/ai-gateway/post-organizations-orgId-ai-chat-completions.md): Creates a chat completion using the specified model via the AI Gateway. Supports both synchronous and streaming (SSE) responses. Set `stream: true` in the request body to receive server-sent events. The request is proxied to the organization's configured AI provider (Bedrock, Azure, Gemini, etc.).
- [Execute analytics query](https://developer.kodexa.ai/api-reference/analytics/execute-analytics-query.md): Runs a server-side dataset query with grouping, metrics, filters, and sorting. The API validates all fields against a fixed dataset catalog and applies FGAC scope checks.
- [List analytics datasets](https://developer.kodexa.ai/api-reference/analytics/get-analytics-datasets.md): Returns the analytics dataset catalog used to drive dashboard query builders (dimensions, metrics, and supported time fields).
- [List analytics datasets](https://developer.kodexa.ai/api-reference/analytics/list-analytics-datasets.md): Returns the analytics dataset catalog used to drive dashboard query builders (dimensions, metrics, and supported time fields).
- [Execute analytics query](https://developer.kodexa.ai/api-reference/analytics/post-analytics-query.md): Runs a server-side dataset query with grouping, metrics, filters, and sorting. The API validates all fields against a fixed dataset catalog and applies FGAC scope checks.
- [Create AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/create-appliedknowledgeset.md): Creates a new AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Delete AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/delete-applied-knowledge-sets-id.md): Permanently deletes the specified AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Delete AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/delete-appliedknowledgeset.md): Permanently deletes the specified AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Get applied knowledge set snapshot](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-set-snapshot.md): Returns the knowledge set snapshot captured at the time this knowledge set was applied.
- [Get applied knowledge set statistics](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-set-statistics.md): Returns application statistics for the specified knowledge set, including counts by status.
- [List Applied Knowledge Sets](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets.md): Returns a paginated list of Applied Knowledge Sets. Applied knowledge set configurations determine which knowledge is available during processing.
- [Get applied knowledge set snapshot](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets-applicationId-snapshot.md): Returns the knowledge set snapshot captured at the time this knowledge set was applied.
- [Get AppliedKnowledgeSet by ID](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets-id.md): Retrieves a single AppliedKnowledgeSet by its unique identifier. Applied knowledge set configurations determine which knowledge is available during processing.
- [Get AppliedKnowledgeSet change sequence](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets-id-sequence.md): Returns the current change sequence number for the specified AppliedKnowledgeSet. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get outdated applied knowledge sets](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets-knowledge-sets-knowledgeSetId-outdated.md): Returns applied knowledge sets that reference outdated snapshots (snapshot doesn't match the current knowledge set snapshot).
- [Get applied knowledge set statistics](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-applied-knowledge-sets-knowledge-sets-knowledgeSetId-stats.md): Returns application statistics for the specified knowledge set, including counts by status.
- [Get AppliedKnowledgeSet by ID](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-appliedknowledgeset-by-id.md): Retrieves a single AppliedKnowledgeSet by its unique identifier. Applied knowledge set configurations determine which knowledge is available during processing.
- [Get AppliedKnowledgeSet change sequence](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-appliedknowledgeset-change-sequence.md): Returns the current change sequence number for the specified AppliedKnowledgeSet. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get outdated applied knowledge sets](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/get-outdated-applied-knowledge-sets.md): Returns applied knowledge sets that reference outdated snapshots (snapshot doesn't match the current knowledge set snapshot).
- [List Applied Knowledge Sets](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/list-applied-knowledge-sets.md): Returns a paginated list of Applied Knowledge Sets. Applied knowledge set configurations determine which knowledge is available during processing.
- [Create AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/post-applied-knowledge-sets.md): Creates a new AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Update AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/put-applied-knowledge-sets-id.md): Updates an existing AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Update AppliedKnowledgeSet](https://developer.kodexa.ai/api-reference/applied-knowledge-sets/update-appliedknowledgeset.md): Updates an existing AppliedKnowledgeSet. Applied knowledge set configurations determine which knowledge is available during processing.
- [Create AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/create-appliedknowledge.md): Creates a new AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [Delete AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/delete-applied-knowledges-id.md): Permanently deletes the specified AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [Delete AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/delete-appliedknowledge.md): Permanently deletes the specified AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [List Applied Knowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/get-applied-knowledges.md): Returns a paginated list of Applied Knowledge. Applied knowledge represents knowledge used during document processing.
- [Get AppliedKnowledge by ID](https://developer.kodexa.ai/api-reference/applied-knowledge/get-applied-knowledges-id.md): Retrieves a single AppliedKnowledge by its unique identifier. Applied knowledge represents knowledge used during document processing.
- [Get AppliedKnowledge change sequence](https://developer.kodexa.ai/api-reference/applied-knowledge/get-applied-knowledges-id-sequence.md): Returns the current change sequence number for the specified AppliedKnowledge. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get AppliedKnowledge by ID](https://developer.kodexa.ai/api-reference/applied-knowledge/get-appliedknowledge-by-id.md): Retrieves a single AppliedKnowledge by its unique identifier. Applied knowledge represents knowledge used during document processing.
- [Get AppliedKnowledge change sequence](https://developer.kodexa.ai/api-reference/applied-knowledge/get-appliedknowledge-change-sequence.md): Returns the current change sequence number for the specified AppliedKnowledge. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Applied Knowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/list-applied-knowledge.md): Returns a paginated list of Applied Knowledge. Applied knowledge represents knowledge used during document processing.
- [Create AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/post-applied-knowledges.md): Creates a new AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [Update AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/put-applied-knowledges-id.md): Updates an existing AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [Update AppliedKnowledge](https://developer.kodexa.ai/api-reference/applied-knowledge/update-appliedknowledge.md): Updates an existing AppliedKnowledge. Applied knowledge represents knowledge used during document processing.
- [Create AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/create-assistantconnection.md): Creates a new AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Delete AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/delete-assistant-connections-id.md): Permanently deletes the specified AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Delete AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/delete-assistantconnection.md): Permanently deletes the specified AssistantConnection. Assistant connections link assistants to external services or APIs.
- [List AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/get-assistant-connections.md): Returns a paginated list of AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Get AssistantConnection by ID](https://developer.kodexa.ai/api-reference/assistantconnection/get-assistant-connections-id.md): Retrieves a single AssistantConnection by its unique identifier. Assistant connections link assistants to external services or APIs.
- [Get AssistantConnection change sequence](https://developer.kodexa.ai/api-reference/assistantconnection/get-assistant-connections-id-sequence.md): Returns the current change sequence number for the specified AssistantConnection. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get AssistantConnection by ID](https://developer.kodexa.ai/api-reference/assistantconnection/get-assistantconnection-by-id.md): Retrieves a single AssistantConnection by its unique identifier. Assistant connections link assistants to external services or APIs.
- [Get AssistantConnection change sequence](https://developer.kodexa.ai/api-reference/assistantconnection/get-assistantconnection-change-sequence.md): Returns the current change sequence number for the specified AssistantConnection. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/list-assistantconnection.md): Returns a paginated list of AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Create AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/post-assistant-connections.md): Creates a new AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Update AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/put-assistant-connections-id.md): Updates an existing AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Update AssistantConnection](https://developer.kodexa.ai/api-reference/assistantconnection/update-assistantconnection.md): Updates an existing AssistantConnection. Assistant connections link assistants to external services or APIs.
- [Create Assistant](https://developer.kodexa.ai/api-reference/assistants/create-assistant.md): Creates a new Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Delete Assistant](https://developer.kodexa.ai/api-reference/assistants/delete-assistant.md): Permanently deletes the specified Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Delete Assistant](https://developer.kodexa.ai/api-reference/assistants/delete-assistants-id.md): Permanently deletes the specified Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Get Assistant by ID](https://developer.kodexa.ai/api-reference/assistants/get-assistant-by-id.md): Retrieves a single Assistant by its unique identifier. Assistants are AI-powered processors that analyze and extract data from documents.
- [Get Assistant change sequence](https://developer.kodexa.ai/api-reference/assistants/get-assistant-change-sequence.md): Returns the current change sequence number for the specified Assistant. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Assistants](https://developer.kodexa.ai/api-reference/assistants/get-assistants.md): Returns a paginated list of Assistants. Assistants are AI-powered processors that analyze and extract data from documents.
- [Get Assistant by ID](https://developer.kodexa.ai/api-reference/assistants/get-assistants-id.md): Retrieves a single Assistant by its unique identifier. Assistants are AI-powered processors that analyze and extract data from documents.
- [Get Assistant change sequence](https://developer.kodexa.ai/api-reference/assistants/get-assistants-id-sequence.md): Returns the current change sequence number for the specified Assistant. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Assistants](https://developer.kodexa.ai/api-reference/assistants/list-assistants.md): Returns a paginated list of Assistants. Assistants are AI-powered processors that analyze and extract data from documents.
- [Create Assistant](https://developer.kodexa.ai/api-reference/assistants/post-assistants.md): Creates a new Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Update Assistant](https://developer.kodexa.ai/api-reference/assistants/put-assistants-id.md): Updates an existing Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Update Assistant](https://developer.kodexa.ai/api-reference/assistants/update-assistant.md): Updates an existing Assistant. Assistants are AI-powered processors that analyze and extract data from documents.
- [Process batch document update](https://developer.kodexa.ai/api-reference/batch-updates/post-batch-update.md): Processes a batch update for multiple document families in a single request. Supports uploading binary files, applying labels, updating notes, and deleting documents. Use multipart/form-data for file uploads or application/json for metadata-only updates.
- [Process batch document update](https://developer.kodexa.ai/api-reference/batch-updates/process-batch-document-update.md): Processes a batch update for multiple document families in a single request. Supports uploading binary files, applying labels, updating notes, and deleting documents. Use multipart/form-data for file uploads or application/json for metadata-only updates.
- [Create Channel](https://developer.kodexa.ai/api-reference/channel/create-channel.md): Creates a new Channel. Channels provide real-time messaging within the platform.
- [Delete all messages in a channel](https://developer.kodexa.ai/api-reference/channel/delete-all-messages-in-a-channel.md): Permanently removes all messages from the specified channel. This action cannot be undone.
- [Delete Channel](https://developer.kodexa.ai/api-reference/channel/delete-channel.md): Permanently deletes the specified Channel. Channels provide real-time messaging within the platform.
- [Delete all messages in a channel](https://developer.kodexa.ai/api-reference/channel/delete-channels-channelId-messages.md): Permanently removes all messages from the specified channel. This action cannot be undone.
- [Delete Channel](https://developer.kodexa.ai/api-reference/channel/delete-channels-id.md): Permanently deletes the specified Channel. Channels provide real-time messaging within the platform.
- [Get Channel by ID](https://developer.kodexa.ai/api-reference/channel/get-channel-by-id.md): Retrieves a single Channel by its unique identifier. Channels provide real-time messaging within the platform.
- [Get Channel change sequence](https://developer.kodexa.ai/api-reference/channel/get-channel-change-sequence.md): Returns the current change sequence number for the specified Channel. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Channel](https://developer.kodexa.ai/api-reference/channel/get-channels.md): Returns a paginated list of Channel. Channels provide real-time messaging within the platform.
- [Stream messages from a channel via SSE](https://developer.kodexa.ai/api-reference/channel/get-channels-channelId-stream.md): Subscribes to a Kodexa channel and streams messages in real time via Server-Sent Events (SSE), useful for live chat, agent output, and logs.
- [Get Channel by ID](https://developer.kodexa.ai/api-reference/channel/get-channels-id.md): Retrieves a single Channel by its unique identifier. Channels provide real-time messaging within the platform.
- [Get Channel change sequence](https://developer.kodexa.ai/api-reference/channel/get-channels-id-sequence.md): Returns the current change sequence number for the specified Channel. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Channel](https://developer.kodexa.ai/api-reference/channel/list-channel.md): Returns a paginated list of Channel. Channels provide real-time messaging within the platform.
- [Create Channel](https://developer.kodexa.ai/api-reference/channel/post-channels.md): Creates a new Channel. Channels provide real-time messaging within the platform.
- [Update Channel](https://developer.kodexa.ai/api-reference/channel/put-channels-id.md): Updates an existing Channel. Channels provide real-time messaging within the platform.
- [Stream messages from a channel via SSE](https://developer.kodexa.ai/api-reference/channel/stream-messages-from-a-channel-via-sse.md)
- [Update Channel](https://developer.kodexa.ai/api-reference/channel/update-channel.md): Updates an existing Channel. Channels provide real-time messaging within the platform.
- [Create ContentException](https://developer.kodexa.ai/api-reference/content-exception/create-contentexception.md): Creates a new ContentException. Content exceptions record errors during document content processing.
- [Delete ContentException](https://developer.kodexa.ai/api-reference/content-exception/delete-content-exceptions-id.md): Permanently deletes the specified ContentException. Content exceptions record errors during document content processing.
- [Delete ContentException](https://developer.kodexa.ai/api-reference/content-exception/delete-contentexception.md): Permanently deletes the specified ContentException. Content exceptions record errors during document content processing.
- [List Content Exception](https://developer.kodexa.ai/api-reference/content-exception/get-content-exceptions.md): Returns a paginated list of Content Exception. Content exceptions record errors during document content processing.
- [Get ContentException by ID](https://developer.kodexa.ai/api-reference/content-exception/get-content-exceptions-id.md): Retrieves a single ContentException by its unique identifier. Content exceptions record errors during document content processing.
- [Get ContentException change sequence](https://developer.kodexa.ai/api-reference/content-exception/get-content-exceptions-id-sequence.md): Returns the current change sequence number for the specified ContentException. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ContentException by ID](https://developer.kodexa.ai/api-reference/content-exception/get-contentexception-by-id.md): Retrieves a single ContentException by its unique identifier. Content exceptions record errors during document content processing.
- [Get ContentException change sequence](https://developer.kodexa.ai/api-reference/content-exception/get-contentexception-change-sequence.md): Returns the current change sequence number for the specified ContentException. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Content Exception](https://developer.kodexa.ai/api-reference/content-exception/list-content-exception.md): Returns a paginated list of Content Exception. Content exceptions record errors during document content processing.
- [Create ContentException](https://developer.kodexa.ai/api-reference/content-exception/post-content-exceptions.md): Creates a new ContentException. Content exceptions record errors during document content processing.
- [Update ContentException](https://developer.kodexa.ai/api-reference/content-exception/put-content-exceptions-id.md): Updates an existing ContentException. Content exceptions record errors during document content processing.
- [Update ContentException](https://developer.kodexa.ai/api-reference/content-exception/update-contentexception.md): Updates an existing ContentException. Content exceptions record errors during document content processing.
- [Create ContentObject](https://developer.kodexa.ai/api-reference/content-object/create-contentobject.md): Creates a new ContentObject. Content objects represent individual files or processing results within a document family.
- [Delete ContentObject](https://developer.kodexa.ai/api-reference/content-object/delete-content-objects-id.md): Permanently deletes the specified ContentObject. Content objects represent individual files or processing results within a document family.
- [Delete ContentObject](https://developer.kodexa.ai/api-reference/content-object/delete-contentobject.md): Permanently deletes the specified ContentObject. Content objects represent individual files or processing results within a document family.
- [Get content object binary content](https://developer.kodexa.ai/api-reference/content-object/get-content-object-binary-content.md): Downloads the binary content (file) of the content object. Returns the raw file bytes with the appropriate content type header.
- [Get content object metadata preview](https://developer.kodexa.ai/api-reference/content-object/get-content-object-metadata-preview.md): Returns a preview of the content object's metadata, including extracted data and processing results.
- [Get content object page image](https://developer.kodexa.ai/api-reference/content-object/get-content-object-page-image.md): Returns a rendered page image (PNG) of the content object. Use the page parameter to specify which page to render.
- [List Content Object](https://developer.kodexa.ai/api-reference/content-object/get-content-objects.md): Returns a paginated list of Content Object. Content objects represent individual files or processing results within a document family.
- [Get ContentObject by ID](https://developer.kodexa.ai/api-reference/content-object/get-content-objects-id.md): Retrieves a single ContentObject by its unique identifier. Content objects represent individual files or processing results within a document family.
- [Get content object binary content](https://developer.kodexa.ai/api-reference/content-object/get-content-objects-id-content.md): Downloads the binary content (file) of the content object. Returns the raw file bytes with the appropriate content type header.
- [Get content object page image](https://developer.kodexa.ai/api-reference/content-object/get-content-objects-id-image.md): Returns a rendered page image (PNG) of the content object. Use the page parameter to specify which page to render.
- [Get content object metadata preview](https://developer.kodexa.ai/api-reference/content-object/get-content-objects-id-preview.md): Returns a preview of the content object's metadata, including extracted data and processing results.
- [Get ContentObject change sequence](https://developer.kodexa.ai/api-reference/content-object/get-content-objects-id-sequence.md): Returns the current change sequence number for the specified ContentObject. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ContentObject by ID](https://developer.kodexa.ai/api-reference/content-object/get-contentobject-by-id.md): Retrieves a single ContentObject by its unique identifier. Content objects represent individual files or processing results within a document family.
- [Get ContentObject change sequence](https://developer.kodexa.ai/api-reference/content-object/get-contentobject-change-sequence.md): Returns the current change sequence number for the specified ContentObject. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Content Object](https://developer.kodexa.ai/api-reference/content-object/list-content-object.md): Returns a paginated list of Content Object. Content objects represent individual files or processing results within a document family.
- [Create ContentObject](https://developer.kodexa.ai/api-reference/content-object/post-content-objects.md): Creates a new ContentObject. Content objects represent individual files or processing results within a document family.
- [Update ContentObject](https://developer.kodexa.ai/api-reference/content-object/put-content-objects-id.md): Updates an existing ContentObject. Content objects represent individual files or processing results within a document family.
- [Replace content object binary](https://developer.kodexa.ai/api-reference/content-object/put-content-objects-id-content.md): Replaces the raw binary payload of an existing content object by ID, updating the stored file without changing its metadata or references.
- [Replace content object binary](https://developer.kodexa.ai/api-reference/content-object/replace-content-object-binary.md)
- [Update ContentObject](https://developer.kodexa.ai/api-reference/content-object/update-contentobject.md): Updates an existing ContentObject. Content objects represent individual files or processing results within a document family.
- [Create CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/create-credittransaction.md): Creates a new CreditTransaction. Credit transactions record billing credit usage or additions.
- [Delete CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/delete-credit-transactions-id.md): Permanently deletes the specified CreditTransaction. Credit transactions record billing credit usage or additions.
- [Delete CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/delete-credittransaction.md): Permanently deletes the specified CreditTransaction. Credit transactions record billing credit usage or additions.
- [List Credit Transactions](https://developer.kodexa.ai/api-reference/credit-transactions/get-credit-transactions.md): Returns a paginated list of Credit Transactions. Credit transactions record billing credit usage or additions.
- [Get CreditTransaction by ID](https://developer.kodexa.ai/api-reference/credit-transactions/get-credit-transactions-id.md): Retrieves a single CreditTransaction by its unique identifier. Credit transactions record billing credit usage or additions.
- [Get CreditTransaction change sequence](https://developer.kodexa.ai/api-reference/credit-transactions/get-credit-transactions-id-sequence.md): Returns the current change sequence number for the specified CreditTransaction. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get CreditTransaction by ID](https://developer.kodexa.ai/api-reference/credit-transactions/get-credittransaction-by-id.md): Retrieves a single CreditTransaction by its unique identifier. Credit transactions record billing credit usage or additions.
- [Get CreditTransaction change sequence](https://developer.kodexa.ai/api-reference/credit-transactions/get-credittransaction-change-sequence.md): Returns the current change sequence number for the specified CreditTransaction. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Credit Transactions](https://developer.kodexa.ai/api-reference/credit-transactions/list-credit-transactions.md): Returns a paginated list of Credit Transactions. Credit transactions record billing credit usage or additions.
- [Create CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/post-credit-transactions.md): Creates a new CreditTransaction. Credit transactions record billing credit usage or additions.
- [Update CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/put-credit-transactions-id.md): Updates an existing CreditTransaction. Credit transactions record billing credit usage or additions.
- [Update CreditTransaction](https://developer.kodexa.ai/api-reference/credit-transactions/update-credittransaction.md): Updates an existing CreditTransaction. Credit transactions record billing credit usage or additions.
- [Create Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/create-taxonomies.md): Creates a new Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [Delete Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/delete-data-definitions-id.md): Permanently deletes the specified Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [Delete Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/delete-taxonomies.md): Permanently deletes the specified Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [List Data Definitions](https://developer.kodexa.ai/api-reference/data-definitions/get-data-definitions.md): Returns a paginated list of Data Definitions. Data definitions (taxonomies) define document structure and extraction rules.
- [Get Taxonomies by ID](https://developer.kodexa.ai/api-reference/data-definitions/get-data-definitions-id.md): Retrieves a single Taxonomies by its unique identifier. Data definitions (taxonomies) define document structure and extraction rules.
- [Get Taxonomies change sequence](https://developer.kodexa.ai/api-reference/data-definitions/get-data-definitions-id-sequence.md): Returns the current change sequence number for the specified Taxonomies. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get Taxonomies by ID](https://developer.kodexa.ai/api-reference/data-definitions/get-taxonomies-by-id.md): Retrieves a single Taxonomies by its unique identifier. Data definitions (taxonomies) define document structure and extraction rules.
- [Get Taxonomies change sequence](https://developer.kodexa.ai/api-reference/data-definitions/get-taxonomies-change-sequence.md): Returns the current change sequence number for the specified Taxonomies. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Data Definitions](https://developer.kodexa.ai/api-reference/data-definitions/list-data-definitions.md): Returns a paginated list of Data Definitions. Data definitions (taxonomies) define document structure and extraction rules.
- [Create Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/post-data-definitions.md): Creates a new Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [Update Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/put-data-definitions-id.md): Updates an existing Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [Update Taxonomies](https://developer.kodexa.ai/api-reference/data-definitions/update-taxonomies.md): Updates an existing Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.
- [Create DataForms](https://developer.kodexa.ai/api-reference/data-forms/create-dataforms.md): Creates a new DataForms. Data forms define structured data capture forms for documents.
- [Delete DataForms](https://developer.kodexa.ai/api-reference/data-forms/delete-data-forms-id.md): Permanently deletes the specified DataForms. Data forms define structured data capture forms for documents.
- [Delete DataForms](https://developer.kodexa.ai/api-reference/data-forms/delete-dataforms.md): Permanently deletes the specified DataForms. Data forms define structured data capture forms for documents.
- [List Data Forms](https://developer.kodexa.ai/api-reference/data-forms/get-data-forms.md): Returns a paginated list of Data Forms. Data forms define structured data capture forms for documents.
- [Get DataForms by ID](https://developer.kodexa.ai/api-reference/data-forms/get-data-forms-id.md): Retrieves a single DataForms by its unique identifier. Data forms define structured data capture forms for documents.
- [Get DataForms change sequence](https://developer.kodexa.ai/api-reference/data-forms/get-data-forms-id-sequence.md): Returns the current change sequence number for the specified DataForms. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DataForms by ID](https://developer.kodexa.ai/api-reference/data-forms/get-dataforms-by-id.md): Retrieves a single DataForms by its unique identifier. Data forms define structured data capture forms for documents.
- [Get DataForms change sequence](https://developer.kodexa.ai/api-reference/data-forms/get-dataforms-change-sequence.md): Returns the current change sequence number for the specified DataForms. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Data Forms](https://developer.kodexa.ai/api-reference/data-forms/list-data-forms.md): Returns a paginated list of Data Forms. Data forms define structured data capture forms for documents.
- [Create DataForms](https://developer.kodexa.ai/api-reference/data-forms/post-data-forms.md): Creates a new DataForms. Data forms define structured data capture forms for documents.
- [Update DataForms](https://developer.kodexa.ai/api-reference/data-forms/put-data-forms-id.md): Updates an existing DataForms. Data forms define structured data capture forms for documents.
- [Update DataForms](https://developer.kodexa.ai/api-reference/data-forms/update-dataforms.md): Updates an existing DataForms. Data forms define structured data capture forms for documents.
- [Create DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/create-datastoremetadata.md): Creates a new DataStoreMetadata. Data stores provide structured data storage.
- [Delete DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/delete-data-stores-id.md): Permanently deletes the specified DataStoreMetadata. Data stores provide structured data storage.
- [Delete DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/delete-datastoremetadata.md): Permanently deletes the specified DataStoreMetadata. Data stores provide structured data storage.
- [List Data Stores](https://developer.kodexa.ai/api-reference/data-stores/get-data-stores.md): Returns a paginated list of Data Stores. Data stores provide structured data storage.
- [Get DataStoreMetadata by ID](https://developer.kodexa.ai/api-reference/data-stores/get-data-stores-id.md): Retrieves a single DataStoreMetadata by its unique identifier. Data stores provide structured data storage.
- [Get DataStoreMetadata change sequence](https://developer.kodexa.ai/api-reference/data-stores/get-data-stores-id-sequence.md): Returns the current change sequence number for the specified DataStoreMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DataStoreMetadata by ID](https://developer.kodexa.ai/api-reference/data-stores/get-datastoremetadata-by-id.md): Retrieves a single DataStoreMetadata by its unique identifier. Data stores provide structured data storage.
- [Get DataStoreMetadata change sequence](https://developer.kodexa.ai/api-reference/data-stores/get-datastoremetadata-change-sequence.md): Returns the current change sequence number for the specified DataStoreMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Data Stores](https://developer.kodexa.ai/api-reference/data-stores/list-data-stores.md): Returns a paginated list of Data Stores. Data stores provide structured data storage.
- [Create DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/post-data-stores.md): Creates a new DataStoreMetadata. Data stores provide structured data storage.
- [Update DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/put-data-stores-id.md): Updates an existing DataStoreMetadata. Data stores provide structured data storage.
- [Update DataStoreMetadata](https://developer.kodexa.ai/api-reference/data-stores/update-datastoremetadata.md): Updates an existing DataStoreMetadata. Data stores provide structured data storage.
- [Create DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/create-documentassignment.md): Creates a new DocumentAssignment. Document assignments link document families to users for review.
- [Delete DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/delete-document-assignments-id.md): Permanently deletes the specified DocumentAssignment. Document assignments link document families to users for review.
- [Delete DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/delete-documentassignment.md): Permanently deletes the specified DocumentAssignment. Document assignments link document families to users for review.
- [List Document Assignments](https://developer.kodexa.ai/api-reference/document-assignments/get-document-assignments.md): Returns a paginated list of Document Assignments. Document assignments link document families to users for review.
- [Get DocumentAssignment by ID](https://developer.kodexa.ai/api-reference/document-assignments/get-document-assignments-id.md): Retrieves a single DocumentAssignment by its unique identifier. Document assignments link document families to users for review.
- [Get DocumentAssignment change sequence](https://developer.kodexa.ai/api-reference/document-assignments/get-document-assignments-id-sequence.md): Returns the current change sequence number for the specified DocumentAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DocumentAssignment by ID](https://developer.kodexa.ai/api-reference/document-assignments/get-documentassignment-by-id.md): Retrieves a single DocumentAssignment by its unique identifier. Document assignments link document families to users for review.
- [Get DocumentAssignment change sequence](https://developer.kodexa.ai/api-reference/document-assignments/get-documentassignment-change-sequence.md): Returns the current change sequence number for the specified DocumentAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Document Assignments](https://developer.kodexa.ai/api-reference/document-assignments/list-document-assignments.md): Returns a paginated list of Document Assignments. Document assignments link document families to users for review.
- [Create DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/post-document-assignments.md): Creates a new DocumentAssignment. Document assignments link document families to users for review.
- [Update DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/put-document-assignments-id.md): Updates an existing DocumentAssignment. Document assignments link document families to users for review.
- [Update DocumentAssignment](https://developer.kodexa.ai/api-reference/document-assignments/update-documentassignment.md): Updates an existing DocumentAssignment. Document assignments link document families to users for review.
- [Create DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/create-documentfamilystatistics.md): Creates a new DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [Delete DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/delete-document-family-statistics-id.md): Permanently deletes the specified DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [Delete DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/delete-documentfamilystatistics.md): Permanently deletes the specified DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [List Document Family Statistics](https://developer.kodexa.ai/api-reference/document-family-statistics/get-document-family-statistics.md): Returns a paginated list of Document Family Statistics. Document family statistics contain processing metrics for document families.
- [Get DocumentFamilyStatistics by ID](https://developer.kodexa.ai/api-reference/document-family-statistics/get-document-family-statistics-id.md): Retrieves a single DocumentFamilyStatistics by its unique identifier. Document family statistics contain processing metrics for document families.
- [Get DocumentFamilyStatistics change sequence](https://developer.kodexa.ai/api-reference/document-family-statistics/get-document-family-statistics-id-sequence.md): Returns the current change sequence number for the specified DocumentFamilyStatistics. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DocumentFamilyStatistics by ID](https://developer.kodexa.ai/api-reference/document-family-statistics/get-documentfamilystatistics-by-id.md): Retrieves a single DocumentFamilyStatistics by its unique identifier. Document family statistics contain processing metrics for document families.
- [Get DocumentFamilyStatistics change sequence](https://developer.kodexa.ai/api-reference/document-family-statistics/get-documentfamilystatistics-change-sequence.md): Returns the current change sequence number for the specified DocumentFamilyStatistics. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Document Family Statistics](https://developer.kodexa.ai/api-reference/document-family-statistics/list-document-family-statistics.md): Returns a paginated list of Document Family Statistics. Document family statistics contain processing metrics for document families.
- [Create DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/post-document-family-statistics.md): Creates a new DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [Update DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/put-document-family-statistics-id.md): Updates an existing DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [Update DocumentFamilyStatistics](https://developer.kodexa.ai/api-reference/document-family-statistics/update-documentfamilystatistics.md): Updates an existing DocumentFamilyStatistics. Document family statistics contain processing metrics for document families.
- [Create DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/create-documentstatus.md): Creates a new DocumentStatus. Document statuses define named states for tracking document processing.
- [Delete DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/delete-document-statuses-id.md): Permanently deletes the specified DocumentStatus. Document statuses define named states for tracking document processing.
- [Delete DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/delete-documentstatus.md): Permanently deletes the specified DocumentStatus. Document statuses define named states for tracking document processing.
- [List Document Statuses](https://developer.kodexa.ai/api-reference/document-statuses/get-document-statuses.md): Returns a paginated list of Document Statuses. Document statuses define named states for tracking document processing.
- [Get DocumentStatus by ID](https://developer.kodexa.ai/api-reference/document-statuses/get-document-statuses-id.md): Retrieves a single DocumentStatus by its unique identifier. Document statuses define named states for tracking document processing.
- [Get DocumentStatus change sequence](https://developer.kodexa.ai/api-reference/document-statuses/get-document-statuses-id-sequence.md): Returns the current change sequence number for the specified DocumentStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DocumentStatus by ID](https://developer.kodexa.ai/api-reference/document-statuses/get-documentstatus-by-id.md): Retrieves a single DocumentStatus by its unique identifier. Document statuses define named states for tracking document processing.
- [Get DocumentStatus change sequence](https://developer.kodexa.ai/api-reference/document-statuses/get-documentstatus-change-sequence.md): Returns the current change sequence number for the specified DocumentStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Document Statuses](https://developer.kodexa.ai/api-reference/document-statuses/list-document-statuses.md): Returns a paginated list of Document Statuses. Document statuses define named states for tracking document processing.
- [Create DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/post-document-statuses.md): Creates a new DocumentStatus. Document statuses define named states for tracking document processing.
- [Update DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/put-document-statuses-id.md): Updates an existing DocumentStatus. Document statuses define named states for tracking document processing.
- [Update DocumentStatus](https://developer.kodexa.ai/api-reference/document-statuses/update-documentstatus.md): Updates an existing DocumentStatus. Document statuses define named states for tracking document processing.
- [Create DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/create-documentstores.md): Creates a new DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [Delete DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/delete-document-stores-id.md): Permanently deletes the specified DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [Delete DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/delete-documentstores.md): Permanently deletes the specified DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [List Document Stores](https://developer.kodexa.ai/api-reference/document-stores/get-document-stores.md): Returns a paginated list of Document Stores. Document stores are containers for organizing and processing documents within a project.
- [Get DocumentStores by ID](https://developer.kodexa.ai/api-reference/document-stores/get-document-stores-id.md): Retrieves a single DocumentStores by its unique identifier. Document stores are containers for organizing and processing documents within a project.
- [Get DocumentStores change sequence](https://developer.kodexa.ai/api-reference/document-stores/get-document-stores-id-sequence.md): Returns the current change sequence number for the specified DocumentStores. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DocumentStores by ID](https://developer.kodexa.ai/api-reference/document-stores/get-documentstores-by-id.md): Retrieves a single DocumentStores by its unique identifier. Document stores are containers for organizing and processing documents within a project.
- [Get DocumentStores change sequence](https://developer.kodexa.ai/api-reference/document-stores/get-documentstores-change-sequence.md): Returns the current change sequence number for the specified DocumentStores. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Document Stores](https://developer.kodexa.ai/api-reference/document-stores/list-document-stores.md): Returns a paginated list of Document Stores. Document stores are containers for organizing and processing documents within a project.
- [Create DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/post-document-stores.md): Creates a new DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [Upload file to document store](https://developer.kodexa.ai/api-reference/document-stores/post-document-stores-id-upload.md): Uploads a file to the document store, creating a new document family and native content object. The file is stored in S3 and a document family record is created with the given path and metadata.
- [Update DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/put-document-stores-id.md): Updates an existing DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [Update DocumentStores](https://developer.kodexa.ai/api-reference/document-stores/update-documentstores.md): Updates an existing DocumentStores. Document stores are containers for organizing and processing documents within a project.
- [Upload file to document store](https://developer.kodexa.ai/api-reference/document-stores/upload-file-to-document-store.md): Uploads a file to the document store, creating a new document family and native content object. The file is stored in S3 and a document family record is created with the given path and metadata.
- [Create DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/create-documenttransition.md): Creates a new DocumentTransition. Document transitions record state changes through processing stages.
- [Delete DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/delete-document-transitions-id.md): Permanently deletes the specified DocumentTransition. Document transitions record state changes through processing stages.
- [Delete DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/delete-documenttransition.md): Permanently deletes the specified DocumentTransition. Document transitions record state changes through processing stages.
- [List Document Transitions](https://developer.kodexa.ai/api-reference/document-transitions/get-document-transitions.md): Returns a paginated list of Document Transitions. Document transitions record state changes through processing stages.
- [Get DocumentTransition by ID](https://developer.kodexa.ai/api-reference/document-transitions/get-document-transitions-id.md): Retrieves a single DocumentTransition by its unique identifier. Document transitions record state changes through processing stages.
- [Get DocumentTransition change sequence](https://developer.kodexa.ai/api-reference/document-transitions/get-document-transitions-id-sequence.md): Returns the current change sequence number for the specified DocumentTransition. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get DocumentTransition by ID](https://developer.kodexa.ai/api-reference/document-transitions/get-documenttransition-by-id.md): Retrieves a single DocumentTransition by its unique identifier. Document transitions record state changes through processing stages.
- [Get DocumentTransition change sequence](https://developer.kodexa.ai/api-reference/document-transitions/get-documenttransition-change-sequence.md): Returns the current change sequence number for the specified DocumentTransition. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Document Transitions](https://developer.kodexa.ai/api-reference/document-transitions/list-document-transitions.md): Returns a paginated list of Document Transitions. Document transitions record state changes through processing stages.
- [Create DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/post-document-transitions.md): Creates a new DocumentTransition. Document transitions record state changes through processing stages.
- [Update DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/put-document-transitions-id.md): Updates an existing DocumentTransition. Document transitions record state changes through processing stages.
- [Update DocumentTransition](https://developer.kodexa.ai/api-reference/document-transitions/update-documenttransition.md): Updates an existing DocumentTransition. Document transitions record state changes through processing stages.
- [Add a label to a document family](https://developer.kodexa.ai/api-reference/documentfamilies/add-a-label-to-a-document-family.md): Adds a label (tag) to the document family for categorization and filtering.
- [Assess document for knowledge](https://developer.kodexa.ai/api-reference/documentfamilies/assess-document-for-knowledge.md): Evaluates the document family's features against all active knowledge sets for the organization using CNF expression matching. Returns applicable and newly applied knowledge sets, along with any additional features inherited from matching sets.
- [Create DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/create-documentfamily.md): Creates a new DocumentFamily. Document families group related content objects representing a single logical document.
- [Delete DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/delete-document-families-id.md): Permanently deletes the specified DocumentFamily. Document families group related content objects representing a single logical document.
- [Remove document family assignees](https://developer.kodexa.ai/api-reference/documentfamilies/delete-document-families-id-assignees.md): Removes all assignees from the document family.
- [Remove a label from a document family](https://developer.kodexa.ai/api-reference/documentfamilies/delete-document-families-id-labels-labelId.md): Removes a label from the document family.
- [Delete DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/delete-documentfamily.md): Permanently deletes the specified DocumentFamily. Document families group related content objects representing a single logical document.
- [Download original native file](https://developer.kodexa.ai/api-reference/documentfamilies/download-original-native-file.md)
- [Export document family](https://developer.kodexa.ai/api-reference/documentfamilies/export-document-family.md): Exports the document family as a .dfm archive containing all content objects and metadata.
- [Export document family data](https://developer.kodexa.ai/api-reference/documentfamilies/export-document-family-data.md): Exports the extracted data from the document family in the specified format (JSON, CSV, XML, or NDJson).
- [Export document family extracted data](https://developer.kodexa.ai/api-reference/documentfamilies/export-document-family-extracted-data.md)
- [Get applied knowledge sets](https://developer.kodexa.ai/api-reference/documentfamilies/get-applied-knowledge-sets.md): Returns the knowledge sets that have been applied to the specified document family.
- [List DocumentFamilies](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families.md): Returns a paginated list of DocumentFamilies. Document families group related content objects representing a single logical document.
- [Get DocumentFamily by ID](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id.md): Retrieves a single DocumentFamily by its unique identifier. Document families group related content objects representing a single logical document.
- [Get applied knowledge sets](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-applied-knowledge-sets.md): Returns the knowledge sets that have been applied to the specified document family.
- [Export document family data](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-data.md): Exports the extracted data from the document family in the specified format (JSON, CSV, XML, or NDJson).
- [Export document family extracted data](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-data-export.md): Exports the extracted data captured on a document family as a structured download, suitable for downstream ETL, reporting, and audit workflows.
- [Export document family](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-export.md): Exports the document family as a .dfm archive containing all content objects and metadata.
- [Get document family page image](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-image.md): Returns a rendered page image (PNG) of the document family's latest native content object. Use the page parameter to specify which page to render. Serves pre-generated images when available; falls back to on-demand PDF rendering.
- [Get related knowledge items](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-knowledge-items.md): Returns knowledge items related to the specified document family.
- [Download original native file](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-native.md): Downloads the original native file (PDF, image, Word document, etc.) that was uploaded for this document family, with its original filename.
- [Get DocumentFamily change sequence](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-sequence.md): Returns the current change sequence number for the specified DocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Touch document family](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-families-id-touch.md): Triggers event processing for the document family without modifying its content. Use this to re-trigger assistant processing.
- [Get document family page image](https://developer.kodexa.ai/api-reference/documentfamilies/get-document-family-page-image.md): Returns a rendered page image (PNG) of the document family's latest native content object. Use the page parameter to specify which page to render. Serves pre-generated images when available; falls back to on-demand PDF rendering.
- [Get DocumentFamily by ID](https://developer.kodexa.ai/api-reference/documentfamilies/get-documentfamily-by-id.md): Retrieves a single DocumentFamily by its unique identifier. Document families group related content objects representing a single logical document.
- [Get DocumentFamily change sequence](https://developer.kodexa.ai/api-reference/documentfamilies/get-documentfamily-change-sequence.md): Returns the current change sequence number for the specified DocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get related knowledge items](https://developer.kodexa.ai/api-reference/documentfamilies/get-related-knowledge-items.md): Returns knowledge items related to the specified document family.
- [Link knowledge feature to document family](https://developer.kodexa.ai/api-reference/documentfamilies/link-knowledge-feature-to-document-family.md): Links an existing knowledge feature to the document family via the join table, enabling knowledge-based classification and AI-assisted processing.
- [List DocumentFamilies](https://developer.kodexa.ai/api-reference/documentfamilies/list-documentfamilies.md): Returns a paginated list of DocumentFamilies. Document families group related content objects representing a single logical document.
- [Lock a document family](https://developer.kodexa.ai/api-reference/documentfamilies/lock-a-document-family.md): Acquires an exclusive lock on the document family, preventing other users from modifying it.
- [Create DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families.md): Creates a new DocumentFamily. Document families group related content objects representing a single logical document.
- [Link knowledge feature to document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-add-knowledge-feature.md): Links an existing knowledge feature to the document family via the join table, enabling knowledge-based classification and AI-assisted processing.
- [Assess document for knowledge](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-assess.md): Evaluates the document family's features against all active knowledge sets for the organization using CNF expression matching. Returns applicable and newly applied knowledge sets, along with any additional features inherited from matching sets.
- [Add a label to a document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-labels.md): Adds a label (tag) to the document family for categorization and filtering.
- [Lock a document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-lock.md): Acquires an exclusive lock on the document family, preventing other users from modifying it.
- [Upload new content](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-new-content.md): Uploads new content to the document family. Accepts multipart/form-data with the file and optional transition tracking metadata. Returns 400 if the document family is locked.
- [Unlink knowledge feature from document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-remove-knowledge-feature.md): Removes the link between a knowledge feature and the document family. The knowledge feature itself is not deleted.
- [Reprocess a document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-reprocess.md): Rolls back assistant contributions and re-triggers the processing pipeline. If assistantIds are provided, only those assistants' contributions are rolled back; otherwise all assistants are auto-detected from the transition chain.
- [Unlock a document family](https://developer.kodexa.ai/api-reference/documentfamilies/post-document-families-id-unlock.md): Releases the exclusive lock on the document family, allowing other users to modify it.
- [Update DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/put-document-families-id.md): Updates an existing DocumentFamily. Document families group related content objects representing a single logical document.
- [Update document family assignees](https://developer.kodexa.ai/api-reference/documentfamilies/put-document-families-id-assignees.md): Assigns a user to the document family for review.
- [Rename a document family](https://developer.kodexa.ai/api-reference/documentfamilies/put-document-families-id-rename.md): Renames the document family by updating its path.
- [Update document family status](https://developer.kodexa.ai/api-reference/documentfamilies/put-document-families-id-status.md): Updates the processing status of the document family.
- [Remove a label from a document family](https://developer.kodexa.ai/api-reference/documentfamilies/remove-a-label-from-a-document-family.md): Removes a label from the document family.
- [Remove document family assignees](https://developer.kodexa.ai/api-reference/documentfamilies/remove-document-family-assignees.md): Removes all assignees from the document family.
- [Rename a document family](https://developer.kodexa.ai/api-reference/documentfamilies/rename-a-document-family.md): Renames the document family by updating its path.
- [Reprocess a document family](https://developer.kodexa.ai/api-reference/documentfamilies/reprocess-a-document-family.md): Rolls back assistant contributions and re-triggers the processing pipeline. If assistantIds are provided, only those assistants' contributions are rolled back; otherwise all assistants are auto-detected from the transition chain.
- [Touch document family](https://developer.kodexa.ai/api-reference/documentfamilies/touch-document-family.md): Triggers event processing for the document family without modifying its content. Use this to re-trigger assistant processing.
- [Unlink knowledge feature from document family](https://developer.kodexa.ai/api-reference/documentfamilies/unlink-knowledge-feature-from-document-family.md): Removes the link between a knowledge feature and the document family. The knowledge feature itself is not deleted.
- [Unlock a document family](https://developer.kodexa.ai/api-reference/documentfamilies/unlock-a-document-family.md): Releases the exclusive lock on the document family, allowing other users to modify it.
- [Update document family assignees](https://developer.kodexa.ai/api-reference/documentfamilies/update-document-family-assignees.md): Assigns a user to the document family for review.
- [Update document family status](https://developer.kodexa.ai/api-reference/documentfamilies/update-document-family-status.md): Updates the processing status of the document family.
- [Update DocumentFamily](https://developer.kodexa.ai/api-reference/documentfamilies/update-documentfamily.md): Updates an existing DocumentFamily. Document families group related content objects representing a single logical document.
- [Upload new content](https://developer.kodexa.ai/api-reference/documentfamilies/upload-new-content.md): Uploads new content to the document family. Accepts multipart/form-data with the file and optional transition tracking metadata. Returns 400 if the document family is locked.
- [Abort a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/abort-a-multipart-upload.md): Cancels an in-progress multipart upload session and releases the reserved S3 resources.
- [Complete a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/complete-a-multipart-upload.md): Finalises a multipart upload and registers the assembled file as a document family in the store.
- [Complete a presigned upload](https://developer.kodexa.ai/api-reference/documentstores/complete-a-presigned-upload.md): Notify the platform that a presigned upload finished so it can register the document family.
- [Create a document inline (no upload)](https://developer.kodexa.ai/api-reference/documentstores/create-a-document-inline-no-upload.md)
- [Get presigned URLs for upload parts](https://developer.kodexa.ai/api-reference/documentstores/get-presigned-urls-for-upload-parts.md): Returns presigned PUT URLs for the requested part numbers of an in-progress multipart upload.
- [Initiate a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/initiate-a-multipart-upload.md): Initiates an S3 multipart upload session and returns the uploadId, s3Key, and expiry. Use with /multipart-upload-part-urls and /multipart-upload-complete for large files.
- [Create a document inline (no upload)](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-create-document.md): Creates a new document directly inside a document store without uploading a file, useful for synthetic or programmatically generated documents.
- [Abort a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-multipart-upload-abort.md): Cancels an in-progress multipart upload session and releases the reserved S3 resources.
- [Complete a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-multipart-upload-complete.md): Finalises a multipart upload and registers the assembled file as a document family in the store.
- [Get presigned URLs for upload parts](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-multipart-upload-part-urls.md): Returns presigned PUT URLs for the requested part numbers of an in-progress multipart upload.
- [Initiate a multipart upload](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-multipart-upload-request.md): Initiates an S3 multipart upload session and returns the uploadId, s3Key, and expiry. Use with /multipart-upload-part-urls and /multipart-upload-complete for large files.
- [Complete a presigned upload](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-presigned-upload-complete.md): Notify the platform that a presigned upload finished so it can register the document family.
- [Request a presigned upload URL](https://developer.kodexa.ai/api-reference/documentstores/post-document-stores-id-presigned-upload-request.md): Returns a presigned URL the client can PUT directly to S3 for large file uploads.
- [Request a presigned upload URL](https://developer.kodexa.ai/api-reference/documentstores/request-a-presigned-upload-url.md): Returns a presigned URL the client can PUT directly to S3 for large file uploads.
- [Create PlatformEvent](https://developer.kodexa.ai/api-reference/events/create-platformevent.md): Creates a new PlatformEvent. Platform events record system events for notifications and integrations.
- [Delete PlatformEvent](https://developer.kodexa.ai/api-reference/events/delete-events-id.md): Permanently deletes the specified PlatformEvent. Platform events record system events for notifications and integrations.
- [Delete PlatformEvent](https://developer.kodexa.ai/api-reference/events/delete-platformevent.md): Permanently deletes the specified PlatformEvent. Platform events record system events for notifications and integrations.
- [List Events](https://developer.kodexa.ai/api-reference/events/get-events.md): Returns a paginated list of Events. Platform events record system events for notifications and integrations.
- [Get PlatformEvent by ID](https://developer.kodexa.ai/api-reference/events/get-events-id.md): Retrieves a single PlatformEvent by its unique identifier. Platform events record system events for notifications and integrations.
- [Get PlatformEvent change sequence](https://developer.kodexa.ai/api-reference/events/get-events-id-sequence.md): Returns the current change sequence number for the specified PlatformEvent. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get PlatformEvent by ID](https://developer.kodexa.ai/api-reference/events/get-platformevent-by-id.md): Retrieves a single PlatformEvent by its unique identifier. Platform events record system events for notifications and integrations.
- [Get PlatformEvent change sequence](https://developer.kodexa.ai/api-reference/events/get-platformevent-change-sequence.md): Returns the current change sequence number for the specified PlatformEvent. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Events](https://developer.kodexa.ai/api-reference/events/list-events.md): Returns a paginated list of Events. Platform events record system events for notifications and integrations.
- [Create PlatformEvent](https://developer.kodexa.ai/api-reference/events/post-events.md): Creates a new PlatformEvent. Platform events record system events for notifications and integrations.
- [Publish UI event](https://developer.kodexa.ai/api-reference/events/post-events-ui.md): Publishes a single UI event for real-time processing and notification delivery.
- [Publish UI events batch](https://developer.kodexa.ai/api-reference/events/post-events-ui-batch.md): Publishes multiple UI events in a single request for efficient batch processing.
- [Publish UI event](https://developer.kodexa.ai/api-reference/events/publish-ui-event.md): Publishes a single UI event for real-time processing and notification delivery.
- [Publish UI events batch](https://developer.kodexa.ai/api-reference/events/publish-ui-events-batch.md): Publishes multiple UI events in a single request for efficient batch processing.
- [Update PlatformEvent](https://developer.kodexa.ai/api-reference/events/put-events-id.md): Updates an existing PlatformEvent. Platform events record system events for notifications and integrations.
- [Update PlatformEvent](https://developer.kodexa.ai/api-reference/events/update-platformevent.md): Updates an existing PlatformEvent. Platform events record system events for notifications and integrations.
- [Create ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/create-executionslice.md): Creates a new ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Delete ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/delete-execution-slices-id.md): Permanently deletes the specified ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Delete ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/delete-executionslice.md): Permanently deletes the specified ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [List Execution Slices](https://developer.kodexa.ai/api-reference/execution-slices/get-execution-slices.md): Returns a paginated list of Execution Slices. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Get ExecutionSlice by ID](https://developer.kodexa.ai/api-reference/execution-slices/get-execution-slices-id.md): Retrieves a single ExecutionSlice by its unique identifier. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Get ExecutionSlice change sequence](https://developer.kodexa.ai/api-reference/execution-slices/get-execution-slices-id-sequence.md): Returns the current change sequence number for the specified ExecutionSlice. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ExecutionSlice by ID](https://developer.kodexa.ai/api-reference/execution-slices/get-executionslice-by-id.md): Retrieves a single ExecutionSlice by its unique identifier. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Get ExecutionSlice change sequence](https://developer.kodexa.ai/api-reference/execution-slices/get-executionslice-change-sequence.md): Returns the current change sequence number for the specified ExecutionSlice. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Execution Slices](https://developer.kodexa.ai/api-reference/execution-slices/list-execution-slices.md): Returns a paginated list of Execution Slices. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Create ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/post-execution-slices.md): Creates a new ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Update ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/put-execution-slices-id.md): Updates an existing ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Update ExecutionSlice](https://developer.kodexa.ai/api-reference/execution-slices/update-executionslice.md): Updates an existing ExecutionSlice. Execution slices represent batches of work dispatched as a single Lambda/K8s invocation.
- [Cancel a running execution](https://developer.kodexa.ai/api-reference/executions/cancel-a-running-execution.md)
- [Cancel execution](https://developer.kodexa.ai/api-reference/executions/cancel-execution.md): Cancels a running execution. The execution will be marked as cancelled and processing will stop.
- [Clean execution cache](https://developer.kodexa.ai/api-reference/executions/clean-execution-cache.md)
- [Create Execution](https://developer.kodexa.ai/api-reference/executions/create-execution.md): Creates a new Execution. Executions record the details and results of processing sessions.
- [Create execution status message](https://developer.kodexa.ai/api-reference/executions/create-execution-status-message.md): Creates a new status message for the specified execution. A maximum of 10 messages are kept per execution; older messages are automatically removed.
- [Delete Execution](https://developer.kodexa.ai/api-reference/executions/delete-execution.md): Permanently deletes the specified Execution. Executions record the details and results of processing sessions.
- [Clean execution cache](https://developer.kodexa.ai/api-reference/executions/delete-executions-executionId-cache.md): Clears the slice and step cache for a specific execution, freeing storage and forcing downstream steps to recompute results on the next run.
- [Delete Execution](https://developer.kodexa.ai/api-reference/executions/delete-executions-id.md): Permanently deletes the specified Execution. Executions record the details and results of processing sessions.
- [Download slice cache content](https://developer.kodexa.ai/api-reference/executions/download-slice-cache-content.md)
- [Get Execution by ID](https://developer.kodexa.ai/api-reference/executions/get-execution-by-id.md): Retrieves a single Execution by its unique identifier. Executions record the details and results of processing sessions.
- [Get Execution change sequence](https://developer.kodexa.ai/api-reference/executions/get-execution-change-sequence.md): Returns the current change sequence number for the specified Execution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get execution status messages](https://developer.kodexa.ai/api-reference/executions/get-execution-status-messages.md): Returns all status messages for the specified execution, ordered by datetime ascending.
- [List Executions](https://developer.kodexa.ai/api-reference/executions/get-executions.md): Returns a paginated list of Executions. Executions record the details and results of processing sessions.
- [Download slice cache content](https://developer.kodexa.ai/api-reference/executions/get-executions-executionId-slices-sliceId-cache.md): Downloads the cached content for a specific slice of an execution, useful for debugging step output and inspecting intermediate documents.
- [Get execution status messages](https://developer.kodexa.ai/api-reference/executions/get-executions-executionId-status-messages.md): Returns all status messages for the specified execution, ordered by datetime ascending.
- [Get Execution by ID](https://developer.kodexa.ai/api-reference/executions/get-executions-id.md): Retrieves a single Execution by its unique identifier. Executions record the details and results of processing sessions.
- [Get Execution change sequence](https://developer.kodexa.ai/api-reference/executions/get-executions-id-sequence.md): Returns the current change sequence number for the specified Execution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List execution status messages (legacy session route)](https://developer.kodexa.ai/api-reference/executions/get-sessions-sessionId-executions-executionId-status-messages.md): Backward-compatible alias of /executions/{executionId}/status-messages. sessionId is accepted but ignored.
- [List execution status messages (legacy session route)](https://developer.kodexa.ai/api-reference/executions/list-execution-status-messages-legacy-session-route.md): Backward-compatible alias of /executions/{executionId}/status-messages. sessionId is accepted but ignored.
- [List Executions](https://developer.kodexa.ai/api-reference/executions/list-executions.md): Returns a paginated list of Executions. Executions record the details and results of processing sessions.
- [Post execution status message (legacy session route)](https://developer.kodexa.ai/api-reference/executions/post-execution-status-message-legacy-session-route.md): Backward-compatible alias of /executions/{executionId}/status-messages. sessionId is accepted but ignored.
- [Create Execution](https://developer.kodexa.ai/api-reference/executions/post-executions.md): Creates a new Execution. Executions record the details and results of processing sessions.
- [Upload slice cache content](https://developer.kodexa.ai/api-reference/executions/post-executions-executionId-slices-sliceId-cache.md): Caches an intermediate pipeline result for a slice within an execution.
- [Create execution status message](https://developer.kodexa.ai/api-reference/executions/post-executions-executionId-status-messages.md): Creates a new status message for the specified execution. A maximum of 10 messages are kept per execution; older messages are automatically removed.
- [Post execution status message (legacy session route)](https://developer.kodexa.ai/api-reference/executions/post-sessions-sessionId-executions-executionId-status-messages.md): Backward-compatible alias of /executions/{executionId}/status-messages. sessionId is accepted but ignored.
- [Cancel a running execution](https://developer.kodexa.ai/api-reference/executions/put-executions-executionId-cancel.md): Cancels a currently running execution by ID, stopping further pipeline steps and marking the execution as cancelled in the Kodexa platform.
- [Update Execution](https://developer.kodexa.ai/api-reference/executions/put-executions-id.md): Updates an existing Execution. Executions record the details and results of processing sessions.
- [Cancel execution](https://developer.kodexa.ai/api-reference/executions/put-executions-id-cancel.md): Cancels a running execution. The execution will be marked as cancelled and processing will stop.
- [Update Execution](https://developer.kodexa.ai/api-reference/executions/update-execution.md): Updates an existing Execution. Executions record the details and results of processing sessions.
- [Upload slice cache content](https://developer.kodexa.ai/api-reference/executions/upload-slice-cache-content.md): Caches an intermediate pipeline result for a slice within an execution.
- [Abort a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/abort-a-multipart-intake-upload.md): Cancels an in-progress intake multipart upload session.
- [Complete a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/complete-a-multipart-intake-upload.md): Finalises a multipart intake upload and processes the assembled file through the intake pipeline.
- [Complete a presigned upload via intake](https://developer.kodexa.ai/api-reference/intake/complete-a-presigned-upload-via-intake.md): Notifies the platform that a presigned upload finished; the file is run through the intake pipeline and registered as a document family.
- [Create intake token](https://developer.kodexa.ai/api-reference/intake/create-intake-token.md)
- [Delete intake token](https://developer.kodexa.ai/api-reference/intake/delete-intake-token.md)
- [Delete intake token](https://developer.kodexa.ai/api-reference/intake/delete-intakes-id-tokens-tokenId.md): Revokes a single intake token by ID, immediately preventing it from being used to submit documents to the parent intake endpoint or workflow.
- [List intake tokens](https://developer.kodexa.ai/api-reference/intake/get-intakes-id-tokens.md): Lists every access token issued for a specific intake, including IDs, labels, and creation dates, for managing intake authentication securely.
- [Get presigned URLs for intake upload parts](https://developer.kodexa.ai/api-reference/intake/get-presigned-urls-for-intake-upload-parts.md): Returns presigned PUT URLs for the requested part numbers of an in-progress intake multipart upload.
- [Initiate a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/initiate-a-multipart-intake-upload.md): Initiates an S3 multipart upload session for a large file delivered via intake.
- [List intake tokens](https://developer.kodexa.ai/api-reference/intake/list-intake-tokens.md)
- [Upload via intake endpoint](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug.md): Uploads a document via a public intake endpoint identified by org and intake slugs.
- [Abort a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-multipart-upload-abort.md): Cancels an in-progress intake multipart upload session.
- [Complete a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-multipart-upload-complete.md): Finalises a multipart intake upload and processes the assembled file through the intake pipeline.
- [Get presigned URLs for intake upload parts](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-multipart-upload-part-urls.md): Returns presigned PUT URLs for the requested part numbers of an in-progress intake multipart upload.
- [Initiate a multipart intake upload](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-multipart-upload-request.md): Initiates an S3 multipart upload session for a large file delivered via intake.
- [Complete a presigned upload via intake](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-presigned-upload-complete.md): Notifies the platform that a presigned upload finished; the file is run through the intake pipeline and registered as a document family.
- [Request a presigned upload URL via intake](https://developer.kodexa.ai/api-reference/intake/post-intake-orgSlug-intakeSlug-presigned-upload-request.md): Returns a presigned S3 PUT URL the client can use to upload a file directly. Use with /presigned-upload-complete to process the uploaded file through the intake pipeline.
- [Create intake token](https://developer.kodexa.ai/api-reference/intake/post-intakes-id-tokens.md): Creates a new access token for an intake and returns the secret token value that callers use to authenticate document submissions to the intake.
- [Request a presigned upload URL via intake](https://developer.kodexa.ai/api-reference/intake/request-a-presigned-upload-url-via-intake.md): Returns a presigned S3 PUT URL the client can use to upload a file directly. Use with /presigned-upload-complete to process the uploaded file through the intake pipeline.
- [Upload via intake endpoint](https://developer.kodexa.ai/api-reference/intake/upload-via-intake-endpoint.md): Uploads a document via a public intake endpoint identified by org and intake slugs.
- [Create Intake](https://developer.kodexa.ai/api-reference/intakes/create-intake.md): Creates a new Intake. Intakes configure how documents are ingested from external sources.
- [Delete Intake](https://developer.kodexa.ai/api-reference/intakes/delete-intake.md): Permanently deletes the specified Intake. Intakes configure how documents are ingested from external sources.
- [Delete Intake](https://developer.kodexa.ai/api-reference/intakes/delete-intakes-id.md): Permanently deletes the specified Intake. Intakes configure how documents are ingested from external sources.
- [Get Intake by ID](https://developer.kodexa.ai/api-reference/intakes/get-intake-by-id.md): Retrieves a single Intake by its unique identifier. Intakes configure how documents are ingested from external sources.
- [Get Intake change sequence](https://developer.kodexa.ai/api-reference/intakes/get-intake-change-sequence.md): Returns the current change sequence number for the specified Intake. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Intakes](https://developer.kodexa.ai/api-reference/intakes/get-intakes.md): Returns a paginated list of Intakes. Intakes configure how documents are ingested from external sources.
- [Get Intake by ID](https://developer.kodexa.ai/api-reference/intakes/get-intakes-id.md): Retrieves a single Intake by its unique identifier. Intakes configure how documents are ingested from external sources.
- [Get Intake change sequence](https://developer.kodexa.ai/api-reference/intakes/get-intakes-id-sequence.md): Returns the current change sequence number for the specified Intake. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Intakes](https://developer.kodexa.ai/api-reference/intakes/list-intakes.md): Returns a paginated list of Intakes. Intakes configure how documents are ingested from external sources.
- [Create Intake](https://developer.kodexa.ai/api-reference/intakes/post-intakes.md): Creates a new Intake. Intakes configure how documents are ingested from external sources.
- [Update Intake](https://developer.kodexa.ai/api-reference/intakes/put-intakes-id.md): Updates an existing Intake. Intakes configure how documents are ingested from external sources.
- [Update Intake](https://developer.kodexa.ai/api-reference/intakes/update-intake.md): Updates an existing Intake. Intakes configure how documents are ingested from external sources.
- [API Reference](https://developer.kodexa.ai/api-reference/introduction.md): RESTful HTTP API for the Kodexa Platform, covering documents, assistants, agents, knowledge, and workflow orchestration with full programmatic access.
- [Create JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/create-jobdocumentfamilyinteraction.md): Creates a new JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [Delete JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/delete-job-document-family-interactions-id.md): Permanently deletes the specified JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [Delete JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/delete-jobdocumentfamilyinteraction.md): Permanently deletes the specified JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [List Job Document Family Interactions](https://developer.kodexa.ai/api-reference/job-document-family-interactions/get-job-document-family-interactions.md): Returns a paginated list of Job Document Family Interactions. Job document family interactions record a scheduled job's interactions with document families.
- [Get JobDocumentFamilyInteraction by ID](https://developer.kodexa.ai/api-reference/job-document-family-interactions/get-job-document-family-interactions-id.md): Retrieves a single JobDocumentFamilyInteraction by its unique identifier. Job document family interactions record a scheduled job's interactions with document families.
- [Get JobDocumentFamilyInteraction change sequence](https://developer.kodexa.ai/api-reference/job-document-family-interactions/get-job-document-family-interactions-id-sequence.md): Returns the current change sequence number for the specified JobDocumentFamilyInteraction. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get JobDocumentFamilyInteraction by ID](https://developer.kodexa.ai/api-reference/job-document-family-interactions/get-jobdocumentfamilyinteraction-by-id.md): Retrieves a single JobDocumentFamilyInteraction by its unique identifier. Job document family interactions record a scheduled job's interactions with document families.
- [Get JobDocumentFamilyInteraction change sequence](https://developer.kodexa.ai/api-reference/job-document-family-interactions/get-jobdocumentfamilyinteraction-change-sequence.md): Returns the current change sequence number for the specified JobDocumentFamilyInteraction. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Job Document Family Interactions](https://developer.kodexa.ai/api-reference/job-document-family-interactions/list-job-document-family-interactions.md): Returns a paginated list of Job Document Family Interactions. Job document family interactions record a scheduled job's interactions with document families.
- [Create JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/post-job-document-family-interactions.md): Creates a new JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [Update JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/put-job-document-family-interactions-id.md): Updates an existing JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [Update JobDocumentFamilyInteraction](https://developer.kodexa.ai/api-reference/job-document-family-interactions/update-jobdocumentfamilyinteraction.md): Updates an existing JobDocumentFamilyInteraction. Job document family interactions record a scheduled job's interactions with document families.
- [Create KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/create-knowledgeclausefeature.md): Creates a new KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [Delete KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/delete-knowledge-clause-features-id.md): Permanently deletes the specified KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [Delete KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/delete-knowledgeclausefeature.md): Permanently deletes the specified KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [List Knowledge Clause Features](https://developer.kodexa.ai/api-reference/knowledge-clause-features/get-knowledge-clause-features.md): Returns a paginated list of Knowledge Clause Features. Knowledge clause features represent data points within knowledge clauses.
- [Get KnowledgeClauseFeature by ID](https://developer.kodexa.ai/api-reference/knowledge-clause-features/get-knowledge-clause-features-id.md): Retrieves a single KnowledgeClauseFeature by its unique identifier. Knowledge clause features represent data points within knowledge clauses.
- [Get KnowledgeClauseFeature change sequence](https://developer.kodexa.ai/api-reference/knowledge-clause-features/get-knowledge-clause-features-id-sequence.md): Returns the current change sequence number for the specified KnowledgeClauseFeature. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeClauseFeature by ID](https://developer.kodexa.ai/api-reference/knowledge-clause-features/get-knowledgeclausefeature-by-id.md): Retrieves a single KnowledgeClauseFeature by its unique identifier. Knowledge clause features represent data points within knowledge clauses.
- [Get KnowledgeClauseFeature change sequence](https://developer.kodexa.ai/api-reference/knowledge-clause-features/get-knowledgeclausefeature-change-sequence.md): Returns the current change sequence number for the specified KnowledgeClauseFeature. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Clause Features](https://developer.kodexa.ai/api-reference/knowledge-clause-features/list-knowledge-clause-features.md): Returns a paginated list of Knowledge Clause Features. Knowledge clause features represent data points within knowledge clauses.
- [Create KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/post-knowledge-clause-features.md): Creates a new KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [Update KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/put-knowledge-clause-features-id.md): Updates an existing KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [Update KnowledgeClauseFeature](https://developer.kodexa.ai/api-reference/knowledge-clause-features/update-knowledgeclausefeature.md): Updates an existing KnowledgeClauseFeature. Knowledge clause features represent data points within knowledge clauses.
- [Create KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/create-knowledgeclause.md): Creates a new KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [Delete KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/delete-knowledge-clauses-id.md): Permanently deletes the specified KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [Delete KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/delete-knowledgeclause.md): Permanently deletes the specified KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [List Knowledge Clauses](https://developer.kodexa.ai/api-reference/knowledge-clauses/get-knowledge-clauses.md): Returns a paginated list of Knowledge Clauses. Knowledge clauses are segments within knowledge items.
- [Get KnowledgeClause by ID](https://developer.kodexa.ai/api-reference/knowledge-clauses/get-knowledge-clauses-id.md): Retrieves a single KnowledgeClause by its unique identifier. Knowledge clauses are segments within knowledge items.
- [Get KnowledgeClause change sequence](https://developer.kodexa.ai/api-reference/knowledge-clauses/get-knowledge-clauses-id-sequence.md): Returns the current change sequence number for the specified KnowledgeClause. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeClause by ID](https://developer.kodexa.ai/api-reference/knowledge-clauses/get-knowledgeclause-by-id.md): Retrieves a single KnowledgeClause by its unique identifier. Knowledge clauses are segments within knowledge items.
- [Get KnowledgeClause change sequence](https://developer.kodexa.ai/api-reference/knowledge-clauses/get-knowledgeclause-change-sequence.md): Returns the current change sequence number for the specified KnowledgeClause. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Clauses](https://developer.kodexa.ai/api-reference/knowledge-clauses/list-knowledge-clauses.md): Returns a paginated list of Knowledge Clauses. Knowledge clauses are segments within knowledge items.
- [Create KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/post-knowledge-clauses.md): Creates a new KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [Update KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/put-knowledge-clauses-id.md): Updates an existing KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [Update KnowledgeClause](https://developer.kodexa.ai/api-reference/knowledge-clauses/update-knowledgeclause.md): Updates an existing KnowledgeClause. Knowledge clauses are segments within knowledge items.
- [Create KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/create-knowledgefeaturetype.md): Creates a new KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Delete KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/delete-knowledge-feature-types-id.md): Permanently deletes the specified KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Delete KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/delete-knowledgefeaturetype.md): Permanently deletes the specified KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [List Knowledge Feature Types](https://developer.kodexa.ai/api-reference/knowledge-feature-types/get-knowledge-feature-types.md): Returns a paginated list of Knowledge Feature Types. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Get KnowledgeFeatureType by ID](https://developer.kodexa.ai/api-reference/knowledge-feature-types/get-knowledge-feature-types-id.md): Retrieves a single KnowledgeFeatureType by its unique identifier. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Get KnowledgeFeatureType change sequence](https://developer.kodexa.ai/api-reference/knowledge-feature-types/get-knowledge-feature-types-id-sequence.md): Returns the current change sequence number for the specified KnowledgeFeatureType. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeFeatureType by ID](https://developer.kodexa.ai/api-reference/knowledge-feature-types/get-knowledgefeaturetype-by-id.md): Retrieves a single KnowledgeFeatureType by its unique identifier. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Get KnowledgeFeatureType change sequence](https://developer.kodexa.ai/api-reference/knowledge-feature-types/get-knowledgefeaturetype-change-sequence.md): Returns the current change sequence number for the specified KnowledgeFeatureType. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Feature Types](https://developer.kodexa.ai/api-reference/knowledge-feature-types/list-knowledge-feature-types.md): Returns a paginated list of Knowledge Feature Types. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Create KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/post-knowledge-feature-types.md): Creates a new KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Update KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/put-knowledge-feature-types-id.md): Updates an existing KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Update KnowledgeFeatureType](https://developer.kodexa.ai/api-reference/knowledge-feature-types/update-knowledgefeaturetype.md): Updates an existing KnowledgeFeatureType. Knowledge feature types define the kind of data a knowledge feature can hold.
- [Assign feature to document family](https://developer.kodexa.ai/api-reference/knowledge-features/assign-feature-to-document-family.md): Links a knowledge feature to a document family via the join table.
- [Assign feature to knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/assign-feature-to-knowledge-item.md): Links a knowledge feature to a knowledge item.
- [Create KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/create-knowledgefeature.md): Creates a new KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Delete KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/delete-knowledge-features-id.md): Permanently deletes the specified KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Unassign feature from document family](https://developer.kodexa.ai/api-reference/knowledge-features/delete-knowledge-features-unassignFromDocumentFamily.md): Removes the link between a knowledge feature and a document family.
- [Unassign feature from knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/delete-knowledge-features-unassignFromKnowledgeItem.md): Removes the link between a knowledge feature and a knowledge item.
- [Delete KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/delete-knowledgefeature.md): Permanently deletes the specified KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Get features by document family](https://developer.kodexa.ai/api-reference/knowledge-features/get-features-by-document-family.md): Returns knowledge features linked to the specified document family.
- [Get features by knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/get-features-by-knowledge-item.md): Returns knowledge features linked to the specified knowledge item.
- [List Knowledge Features](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledge-features.md): Returns a paginated list of Knowledge Features. Knowledge features represent specific data points within knowledge items.
- [Get features by document family](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledge-features-byDocumentFamily-documentFamilyId.md): Returns knowledge features linked to the specified document family.
- [Get features by knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledge-features-byKnowledgeItem-knowledgeItemId.md): Returns knowledge features linked to the specified knowledge item.
- [Get KnowledgeFeature by ID](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledge-features-id.md): Retrieves a single KnowledgeFeature by its unique identifier. Knowledge features represent specific data points within knowledge items.
- [Get KnowledgeFeature change sequence](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledge-features-id-sequence.md): Returns the current change sequence number for the specified KnowledgeFeature. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeFeature by ID](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledgefeature-by-id.md): Retrieves a single KnowledgeFeature by its unique identifier. Knowledge features represent specific data points within knowledge items.
- [Get KnowledgeFeature change sequence](https://developer.kodexa.ai/api-reference/knowledge-features/get-knowledgefeature-change-sequence.md): Returns the current change sequence number for the specified KnowledgeFeature. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Features](https://developer.kodexa.ai/api-reference/knowledge-features/list-knowledge-features.md): Returns a paginated list of Knowledge Features. Knowledge features represent specific data points within knowledge items.
- [Create KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/post-knowledge-features.md): Creates a new KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Assign feature to document family](https://developer.kodexa.ai/api-reference/knowledge-features/post-knowledge-features-assignToDocumentFamily.md): Links a knowledge feature to a document family via the join table.
- [Assign feature to knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/post-knowledge-features-assignToKnowledgeItem.md): Links a knowledge feature to a knowledge item.
- [Update KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/put-knowledge-features-id.md): Updates an existing KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Unassign feature from document family](https://developer.kodexa.ai/api-reference/knowledge-features/unassign-feature-from-document-family.md): Removes the link between a knowledge feature and a document family.
- [Unassign feature from knowledge item](https://developer.kodexa.ai/api-reference/knowledge-features/unassign-feature-from-knowledge-item.md): Removes the link between a knowledge feature and a knowledge item.
- [Update KnowledgeFeature](https://developer.kodexa.ai/api-reference/knowledge-features/update-knowledgefeature.md): Updates an existing KnowledgeFeature. Knowledge features represent specific data points within knowledge items.
- [Create KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/create-knowledgeitemtype.md): Creates a new KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [Delete KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/delete-knowledge-item-types-id.md): Permanently deletes the specified KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [Delete KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/delete-knowledgeitemtype.md): Permanently deletes the specified KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [List Knowledge Item Types](https://developer.kodexa.ai/api-reference/knowledge-item-types/get-knowledge-item-types.md): Returns a paginated list of Knowledge Item Types. Knowledge item types define the kind of knowledge item.
- [Get KnowledgeItemType by ID](https://developer.kodexa.ai/api-reference/knowledge-item-types/get-knowledge-item-types-id.md): Retrieves a single KnowledgeItemType by its unique identifier. Knowledge item types define the kind of knowledge item.
- [Get KnowledgeItemType change sequence](https://developer.kodexa.ai/api-reference/knowledge-item-types/get-knowledge-item-types-id-sequence.md): Returns the current change sequence number for the specified KnowledgeItemType. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeItemType by ID](https://developer.kodexa.ai/api-reference/knowledge-item-types/get-knowledgeitemtype-by-id.md): Retrieves a single KnowledgeItemType by its unique identifier. Knowledge item types define the kind of knowledge item.
- [Get KnowledgeItemType change sequence](https://developer.kodexa.ai/api-reference/knowledge-item-types/get-knowledgeitemtype-change-sequence.md): Returns the current change sequence number for the specified KnowledgeItemType. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Item Types](https://developer.kodexa.ai/api-reference/knowledge-item-types/list-knowledge-item-types.md): Returns a paginated list of Knowledge Item Types. Knowledge item types define the kind of knowledge item.
- [Create KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/post-knowledge-item-types.md): Creates a new KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [Update KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/put-knowledge-item-types-id.md): Updates an existing KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [Update KnowledgeItemType](https://developer.kodexa.ai/api-reference/knowledge-item-types/update-knowledgeitemtype.md): Updates an existing KnowledgeItemType. Knowledge item types define the kind of knowledge item.
- [Create KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/create-knowledgeitem.md): Creates a new KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Delete knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/delete-knowledge-item-attachment.md): Deletes the attachment from the knowledge item.
- [Delete KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/delete-knowledge-items-id.md): Permanently deletes the specified KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Delete knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/delete-knowledge-items-id-attachment.md): Deletes the attachment from the knowledge item.
- [Delete KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/delete-knowledgeitem.md): Permanently deletes the specified KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Get document families for knowledge item](https://developer.kodexa.ai/api-reference/knowledge-items/get-document-families-for-knowledge-item.md): Returns document families that share features with the specified knowledge item.
- [Get knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-item-attachment.md): Downloads the attachment file for the knowledge item.
- [List Knowledge Items](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-items.md): Returns a paginated list of Knowledge Items. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Get KnowledgeItem by ID](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-items-id.md): Retrieves a single KnowledgeItem by its unique identifier. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Get knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-items-id-attachment.md): Downloads the attachment file for the knowledge item.
- [Get document families for knowledge item](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-items-id-documentFamilies.md): Returns document families that share features with the specified knowledge item.
- [Get KnowledgeItem change sequence](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledge-items-id-sequence.md): Returns the current change sequence number for the specified KnowledgeItem. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeItem by ID](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledgeitem-by-id.md): Retrieves a single KnowledgeItem by its unique identifier. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Get KnowledgeItem change sequence](https://developer.kodexa.ai/api-reference/knowledge-items/get-knowledgeitem-change-sequence.md): Returns the current change sequence number for the specified KnowledgeItem. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Items](https://developer.kodexa.ai/api-reference/knowledge-items/list-knowledge-items.md): Returns a paginated list of Knowledge Items. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Create KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/post-knowledge-items.md): Creates a new KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Upload knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/post-knowledge-items-id-attachment.md): Uploads an attachment file to the knowledge item.
- [Update KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/put-knowledge-items-id.md): Updates an existing KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Update KnowledgeItem](https://developer.kodexa.ai/api-reference/knowledge-items/update-knowledgeitem.md): Updates an existing KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.
- [Upload knowledge item attachment](https://developer.kodexa.ai/api-reference/knowledge-items/upload-knowledge-item-attachment.md): Uploads an attachment file to the knowledge item.
- [Create KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/create-knowledgesetsnapshot.md): Creates a new KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Delete KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/delete-knowledge-set-snapshots-id.md): Permanently deletes the specified KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Delete KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/delete-knowledgesetsnapshot.md): Permanently deletes the specified KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [List Knowledge Set Snapshots](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/get-knowledge-set-snapshots.md): Returns a paginated list of Knowledge Set Snapshots. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Get KnowledgeSetSnapshot by ID](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/get-knowledge-set-snapshots-id.md): Retrieves a single KnowledgeSetSnapshot by its unique identifier. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Get KnowledgeSetSnapshot change sequence](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/get-knowledge-set-snapshots-id-sequence.md): Returns the current change sequence number for the specified KnowledgeSetSnapshot. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeSetSnapshot by ID](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/get-knowledgesetsnapshot-by-id.md): Retrieves a single KnowledgeSetSnapshot by its unique identifier. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Get KnowledgeSetSnapshot change sequence](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/get-knowledgesetsnapshot-change-sequence.md): Returns the current change sequence number for the specified KnowledgeSetSnapshot. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Set Snapshots](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/list-knowledge-set-snapshots.md): Returns a paginated list of Knowledge Set Snapshots. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Create KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/post-knowledge-set-snapshots.md): Creates a new KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Update KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/put-knowledge-set-snapshots-id.md): Updates an existing KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Update KnowledgeSetSnapshot](https://developer.kodexa.ai/api-reference/knowledge-set-snapshots/update-knowledgesetsnapshot.md): Updates an existing KnowledgeSetSnapshot. Knowledge set snapshots capture the state of a knowledge set at a point in time.
- [Create KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/create-knowledgesetsource.md): Creates a new KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [Delete KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/delete-knowledge-set-sources-id.md): Permanently deletes the specified KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [Delete KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/delete-knowledgesetsource.md): Permanently deletes the specified KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [List Knowledge Set Sources](https://developer.kodexa.ai/api-reference/knowledge-set-sources/get-knowledge-set-sources.md): Returns a paginated list of Knowledge Set Sources. Knowledge set sources reference the origin of knowledge set data.
- [Get KnowledgeSetSource by ID](https://developer.kodexa.ai/api-reference/knowledge-set-sources/get-knowledge-set-sources-id.md): Retrieves a single KnowledgeSetSource by its unique identifier. Knowledge set sources reference the origin of knowledge set data.
- [Get KnowledgeSetSource change sequence](https://developer.kodexa.ai/api-reference/knowledge-set-sources/get-knowledge-set-sources-id-sequence.md): Returns the current change sequence number for the specified KnowledgeSetSource. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeSetSource by ID](https://developer.kodexa.ai/api-reference/knowledge-set-sources/get-knowledgesetsource-by-id.md): Retrieves a single KnowledgeSetSource by its unique identifier. Knowledge set sources reference the origin of knowledge set data.
- [Get KnowledgeSetSource change sequence](https://developer.kodexa.ai/api-reference/knowledge-set-sources/get-knowledgesetsource-change-sequence.md): Returns the current change sequence number for the specified KnowledgeSetSource. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Knowledge Set Sources](https://developer.kodexa.ai/api-reference/knowledge-set-sources/list-knowledge-set-sources.md): Returns a paginated list of Knowledge Set Sources. Knowledge set sources reference the origin of knowledge set data.
- [Create KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/post-knowledge-set-sources.md): Creates a new KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [Update KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/put-knowledge-set-sources-id.md): Updates an existing KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [Update KnowledgeSetSource](https://developer.kodexa.ai/api-reference/knowledge-set-sources/update-knowledgesetsource.md): Updates an existing KnowledgeSetSource. Knowledge set sources reference the origin of knowledge set data.
- [Create KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/create-knowledgeset.md): Creates a new KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Delete knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/delete-knowledge-set-attachment.md)
- [Delete KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/delete-knowledge-sets-id.md): Permanently deletes the specified KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Delete knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/delete-knowledge-sets-id-attachments-attachmentId.md): Removes a single attachment from a knowledge set by its attachment ID, permanently deleting the file and its embeddings from the search index.
- [Delete KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/delete-knowledgeset.md): Permanently deletes the specified KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Download knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/download-knowledge-set-attachment.md)
- [List Knowledge Sets](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets.md): Returns a paginated list of Knowledge Sets. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Get knowledge sets by type](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-by-type.md): Returns knowledge sets filtered by the specified type.
- [Get knowledge sets by type](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-byType-setType.md): Returns knowledge sets filtered by the specified type.
- [Get KnowledgeSet by ID](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-id.md): Retrieves a single KnowledgeSet by its unique identifier. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [List knowledge set attachments](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-id-attachments.md): Lists all attachments stored in a knowledge set, with metadata such as filename, size, and upload date, for browsing indexed knowledge sources.
- [Download knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-id-attachments-attachmentId.md): Downloads a specific attachment file from a knowledge set by attachment ID, returning the original binary content exactly as it was uploaded.
- [Get KnowledgeSet change sequence](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledge-sets-id-sequence.md): Returns the current change sequence number for the specified KnowledgeSet. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get KnowledgeSet by ID](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledgeset-by-id.md): Retrieves a single KnowledgeSet by its unique identifier. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Get KnowledgeSet change sequence](https://developer.kodexa.ai/api-reference/knowledge-sets/get-knowledgeset-change-sequence.md): Returns the current change sequence number for the specified KnowledgeSet. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List knowledge set attachments](https://developer.kodexa.ai/api-reference/knowledge-sets/list-knowledge-set-attachments.md)
- [List Knowledge Sets](https://developer.kodexa.ai/api-reference/knowledge-sets/list-knowledge-sets.md): Returns a paginated list of Knowledge Sets. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Create KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/post-knowledge-sets.md): Creates a new KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Upload knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/post-knowledge-sets-id-attachments.md): Uploads a new attachment file to a knowledge set, automatically chunking and embedding its contents so it can be searched and retrieved by agents.
- [Update KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/put-knowledge-sets-id.md): Updates an existing KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Update KnowledgeSet](https://developer.kodexa.ai/api-reference/knowledge-sets/update-knowledgeset.md): Updates an existing KnowledgeSet. Knowledge sets are collections of extracted knowledge used for AI-assisted processing.
- [Upload knowledge set attachment](https://developer.kodexa.ai/api-reference/knowledge-sets/upload-knowledge-set-attachment.md)
- [Create Label](https://developer.kodexa.ai/api-reference/labels/create-label.md): Creates a new Label. Labels are used for categorizing and tagging resources within an organization.
- [Delete Label](https://developer.kodexa.ai/api-reference/labels/delete-label.md): Permanently deletes the specified Label. Labels are used for categorizing and tagging resources within an organization.
- [Delete Label](https://developer.kodexa.ai/api-reference/labels/delete-labels-id.md): Permanently deletes the specified Label. Labels are used for categorizing and tagging resources within an organization.
- [Get Label by ID](https://developer.kodexa.ai/api-reference/labels/get-label-by-id.md): Retrieves a single Label by its unique identifier. Labels are used for categorizing and tagging resources within an organization.
- [Get Label change sequence](https://developer.kodexa.ai/api-reference/labels/get-label-change-sequence.md): Returns the current change sequence number for the specified Label. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Labels](https://developer.kodexa.ai/api-reference/labels/get-labels.md): Returns a paginated list of Labels. Labels are used for categorizing and tagging resources within an organization.
- [Get Label by ID](https://developer.kodexa.ai/api-reference/labels/get-labels-id.md): Retrieves a single Label by its unique identifier. Labels are used for categorizing and tagging resources within an organization.
- [Get Label change sequence](https://developer.kodexa.ai/api-reference/labels/get-labels-id-sequence.md): Returns the current change sequence number for the specified Label. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Labels](https://developer.kodexa.ai/api-reference/labels/list-labels.md): Returns a paginated list of Labels. Labels are used for categorizing and tagging resources within an organization.
- [Create Label](https://developer.kodexa.ai/api-reference/labels/post-labels.md): Creates a new Label. Labels are used for categorizing and tagging resources within an organization.
- [Update Label](https://developer.kodexa.ai/api-reference/labels/put-labels-id.md): Updates an existing Label. Labels are used for categorizing and tagging resources within an organization.
- [Update Label](https://developer.kodexa.ai/api-reference/labels/update-label.md): Updates an existing Label. Labels are used for categorizing and tagging resources within an organization.
- [Create LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/create-linkeddelta.md): Creates a new LinkedDelta. Linked deltas represent changes between document versions.
- [Delete LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/delete-linked-deltas-id.md): Permanently deletes the specified LinkedDelta. Linked deltas represent changes between document versions.
- [Delete LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/delete-linkeddelta.md): Permanently deletes the specified LinkedDelta. Linked deltas represent changes between document versions.
- [List Linked Deltas](https://developer.kodexa.ai/api-reference/linked-deltas/get-linked-deltas.md): Returns a paginated list of Linked Deltas. Linked deltas represent changes between document versions.
- [Get LinkedDelta by ID](https://developer.kodexa.ai/api-reference/linked-deltas/get-linked-deltas-id.md): Retrieves a single LinkedDelta by its unique identifier. Linked deltas represent changes between document versions.
- [Get LinkedDelta change sequence](https://developer.kodexa.ai/api-reference/linked-deltas/get-linked-deltas-id-sequence.md): Returns the current change sequence number for the specified LinkedDelta. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get LinkedDelta by ID](https://developer.kodexa.ai/api-reference/linked-deltas/get-linkeddelta-by-id.md): Retrieves a single LinkedDelta by its unique identifier. Linked deltas represent changes between document versions.
- [Get LinkedDelta change sequence](https://developer.kodexa.ai/api-reference/linked-deltas/get-linkeddelta-change-sequence.md): Returns the current change sequence number for the specified LinkedDelta. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Linked Deltas](https://developer.kodexa.ai/api-reference/linked-deltas/list-linked-deltas.md): Returns a paginated list of Linked Deltas. Linked deltas represent changes between document versions.
- [Create LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/post-linked-deltas.md): Creates a new LinkedDelta. Linked deltas represent changes between document versions.
- [Update LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/put-linked-deltas-id.md): Updates an existing LinkedDelta. Linked deltas represent changes between document versions.
- [Update LinkedDelta](https://developer.kodexa.ai/api-reference/linked-deltas/update-linkeddelta.md): Updates an existing LinkedDelta. Linked deltas represent changes between document versions.
- [Create Message](https://developer.kodexa.ai/api-reference/messages/create-message.md): Creates a new Message. Messages are individual communications within a channel.
- [Delete Message](https://developer.kodexa.ai/api-reference/messages/delete-message.md): Permanently deletes the specified Message. Messages are individual communications within a channel.
- [Delete Message](https://developer.kodexa.ai/api-reference/messages/delete-messages-id.md): Permanently deletes the specified Message. Messages are individual communications within a channel.
- [Get Message by ID](https://developer.kodexa.ai/api-reference/messages/get-message-by-id.md): Retrieves a single Message by its unique identifier. Messages are individual communications within a channel.
- [Get Message change sequence](https://developer.kodexa.ai/api-reference/messages/get-message-change-sequence.md): Returns the current change sequence number for the specified Message. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Messages](https://developer.kodexa.ai/api-reference/messages/get-messages.md): Returns a paginated list of Messages. Messages are individual communications within a channel.
- [Get Message by ID](https://developer.kodexa.ai/api-reference/messages/get-messages-id.md): Retrieves a single Message by its unique identifier. Messages are individual communications within a channel.
- [Get Message change sequence](https://developer.kodexa.ai/api-reference/messages/get-messages-id-sequence.md): Returns the current change sequence number for the specified Message. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Messages](https://developer.kodexa.ai/api-reference/messages/list-messages.md): Returns a paginated list of Messages. Messages are individual communications within a channel.
- [Create Message](https://developer.kodexa.ai/api-reference/messages/post-messages.md): Creates a new Message. Messages are individual communications within a channel.
- [Update Message](https://developer.kodexa.ai/api-reference/messages/put-messages-id.md): Updates an existing Message. Messages are individual communications within a channel.
- [Update Message](https://developer.kodexa.ai/api-reference/messages/update-message.md): Updates an existing Message. Messages are individual communications within a channel.
- [Get aggregated model costs](https://developer.kodexa.ai/api-reference/model-costs/get-aggregated-model-costs.md): Returns aggregated model cost data for the current organization, including token usage and billing information.
- [Get aggregated model costs](https://developer.kodexa.ai/api-reference/model-costs/get-model-costs.md): Returns aggregated model cost data for the current organization, including token usage and billing information.
- [Create OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/create-orchestratormoduleruntime.md): Creates a new OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Delete OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/delete-module-runtimes-id.md): Permanently deletes the specified OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Delete OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/delete-orchestratormoduleruntime.md): Permanently deletes the specified OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Deploy agent runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/deploy-agent-runtimes.md): Proxied to the orchestrator. Platform admin only.
- [Deploy module runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/deploy-module-runtimes.md): Proxied to the orchestrator. Platform admin only.
- [Get module runtime statistics](https://developer.kodexa.ai/api-reference/module-runtimes/get-module-runtime-statistics.md): Returns runtime statistics (invocations, latency, errors) proxied from the orchestrator.
- [List Module Runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/get-module-runtimes.md): Returns a paginated list of Module Runtimes. Module runtimes define processing environments for modules.
- [Get OrchestratorModuleRuntime by ID](https://developer.kodexa.ai/api-reference/module-runtimes/get-module-runtimes-id.md): Retrieves a single OrchestratorModuleRuntime by its unique identifier. Module runtimes define processing environments for modules.
- [Get OrchestratorModuleRuntime change sequence](https://developer.kodexa.ai/api-reference/module-runtimes/get-module-runtimes-id-sequence.md): Returns the current change sequence number for the specified OrchestratorModuleRuntime. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get module runtime statistics](https://developer.kodexa.ai/api-reference/module-runtimes/get-module-runtimes-id-stats.md): Returns runtime statistics (invocations, latency, errors) proxied from the orchestrator.
- [Get OrchestratorModuleRuntime by ID](https://developer.kodexa.ai/api-reference/module-runtimes/get-orchestratormoduleruntime-by-id.md): Retrieves a single OrchestratorModuleRuntime by its unique identifier. Module runtimes define processing environments for modules.
- [Get OrchestratorModuleRuntime change sequence](https://developer.kodexa.ai/api-reference/module-runtimes/get-orchestratormoduleruntime-change-sequence.md): Returns the current change sequence number for the specified OrchestratorModuleRuntime. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Module Runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/list-module-runtimes.md): Returns a paginated list of Module Runtimes. Module runtimes define processing environments for modules.
- [Deploy agent runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/post-agent-runtimes-deploy.md): Proxied to the orchestrator. Platform admin only.
- [Undeploy agent runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/post-agent-runtimes-undeploy.md): Proxied to the orchestrator. Platform admin only.
- [Create OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/post-module-runtimes.md): Creates a new OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Deploy module runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/post-module-runtimes-deploy.md): Proxied to the orchestrator. Platform admin only.
- [Undeploy module runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/post-module-runtimes-undeploy.md): Proxied to the orchestrator. Platform admin only.
- [Update OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/put-module-runtimes-id.md): Updates an existing OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Undeploy agent runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/undeploy-agent-runtimes.md): Proxied to the orchestrator. Platform admin only.
- [Undeploy module runtimes](https://developer.kodexa.ai/api-reference/module-runtimes/undeploy-module-runtimes.md): Proxied to the orchestrator. Platform admin only.
- [Update OrchestratorModuleRuntime](https://developer.kodexa.ai/api-reference/module-runtimes/update-orchestratormoduleruntime.md): Updates an existing OrchestratorModuleRuntime. Module runtimes define processing environments for modules.
- [Create Modules](https://developer.kodexa.ai/api-reference/modules/create-modules.md): Creates a new Modules. Modules are processing modules that can be executed on documents.
- [Delete Modules](https://developer.kodexa.ai/api-reference/modules/delete-modules.md): Permanently deletes the specified Modules. Modules are processing modules that can be executed on documents.
- [Delete Modules](https://developer.kodexa.ai/api-reference/modules/delete-modules-id.md): Permanently deletes the specified Modules. Modules are processing modules that can be executed on documents.
- [Download module implementation ZIP](https://developer.kodexa.ai/api-reference/modules/download-module-implementation-zip.md)
- [List Modules](https://developer.kodexa.ai/api-reference/modules/get-modules.md): Returns a paginated list of Modules. Modules are processing modules that can be executed on documents.
- [Get Modules by ID](https://developer.kodexa.ai/api-reference/modules/get-modules-by-id.md): Retrieves a single Modules by its unique identifier. Modules are processing modules that can be executed on documents.
- [Get Modules change sequence](https://developer.kodexa.ai/api-reference/modules/get-modules-change-sequence.md): Returns the current change sequence number for the specified Modules. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get Modules by ID](https://developer.kodexa.ai/api-reference/modules/get-modules-id.md): Retrieves a single Modules by its unique identifier. Modules are processing modules that can be executed on documents.
- [Download module implementation ZIP](https://developer.kodexa.ai/api-reference/modules/get-modules-id-implementation.md): Downloads the implementation ZIP archive for a module, containing the source code, manifest, and runtime assets needed to run or inspect the module.
- [Get Modules change sequence](https://developer.kodexa.ai/api-reference/modules/get-modules-id-sequence.md): Returns the current change sequence number for the specified Modules. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Modules](https://developer.kodexa.ai/api-reference/modules/list-modules.md): Returns a paginated list of Modules. Modules are processing modules that can be executed on documents.
- [Create Modules](https://developer.kodexa.ai/api-reference/modules/post-modules.md): Creates a new Modules. Modules are processing modules that can be executed on documents.
- [Upload module implementation ZIP](https://developer.kodexa.ai/api-reference/modules/post-modules-id-implementation.md): Uploads a new implementation ZIP archive for a module, replacing its source code, manifest, and runtime assets in the Kodexa platform module registry.
- [Update Modules](https://developer.kodexa.ai/api-reference/modules/put-modules-id.md): Updates an existing Modules. Modules are processing modules that can be executed on documents.
- [Update Modules](https://developer.kodexa.ai/api-reference/modules/update-modules.md): Updates an existing Modules. Modules are processing modules that can be executed on documents.
- [Upload module implementation ZIP](https://developer.kodexa.ai/api-reference/modules/upload-module-implementation-zip.md)
- [Get fair-scheduler config for an org](https://developer.kodexa.ai/api-reference/operations/get-fair-scheduler-config-for-an-org.md)
- [List fair-scheduler orgs](https://developer.kodexa.ai/api-reference/operations/get-fair-scheduler-orgs.md): Lists every organization registered with the Kodexa fair-scheduler, showing each org's queue weight, concurrency limit, and current execution priority.
- [Get fair-scheduler config for an org](https://developer.kodexa.ai/api-reference/operations/get-fair-scheduler-orgs-orgId.md): Returns the fair-scheduler configuration for a single organization, including queue weights, concurrency limits, and execution priority overrides.
- [Operations dashboard executions](https://developer.kodexa.ai/api-reference/operations/get-ops-executions.md): Platform-admin-only proxy returning the operations dashboard's execution list.
- [Operations dashboard fair-scheduler view](https://developer.kodexa.ai/api-reference/operations/get-ops-fair-scheduler-orgs.md): Returns the operations dashboard view of the fair-scheduler, summarizing per-organization queue depth, running jobs, and platform resource fairness.
- [List fair-scheduler orgs](https://developer.kodexa.ai/api-reference/operations/list-fair-scheduler-orgs.md)
- [Operations dashboard executions](https://developer.kodexa.ai/api-reference/operations/operations-dashboard-executions.md): Platform-admin-only proxy returning the operations dashboard's execution list.
- [Operations dashboard fair-scheduler view](https://developer.kodexa.ai/api-reference/operations/operations-dashboard-fair-scheduler-view.md)
- [Update fair-scheduler config for an org](https://developer.kodexa.ai/api-reference/operations/put-fair-scheduler-orgs-orgId.md): Updates the fair-scheduler configuration for a specific organization, adjusting queue weight, concurrency limit, and execution priority overrides.
- [Update fair-scheduler config for an org](https://developer.kodexa.ai/api-reference/operations/update-fair-scheduler-config-for-an-org.md)
- [Activity step error callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/activity-step-error-callback.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step result callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/activity-step-result-callback.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step skip callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/activity-step-skip-callback.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step status callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/activity-step-status-callback.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step error callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/post-orchestrator-activities-id-steps-stepId-error.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step result callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/post-orchestrator-activities-id-steps-stepId-result.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step skip callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/post-orchestrator-activities-id-steps-stepId-skip.md): Internal callback from the orchestrator. Not for external consumers.
- [Activity step status callback](https://developer.kodexa.ai/api-reference/orchestrator-callbacks/post-orchestrator-activities-id-steps-stepId-status.md): Internal callback from the orchestrator. Not for external consumers.
- [Create OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/create-orchestratormodule.md): Creates a new OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [Delete OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/delete-orchestrator-modules-id.md): Permanently deletes the specified OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [Delete OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/delete-orchestratormodule.md): Permanently deletes the specified OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [List Orchestrator Modules](https://developer.kodexa.ai/api-reference/orchestrator-modules/get-orchestrator-modules.md): Returns a paginated list of Orchestrator Modules. Orchestrator modules are processing components used within pipelines.
- [Get OrchestratorModule by ID](https://developer.kodexa.ai/api-reference/orchestrator-modules/get-orchestrator-modules-id.md): Retrieves a single OrchestratorModule by its unique identifier. Orchestrator modules are processing components used within pipelines.
- [Get OrchestratorModule change sequence](https://developer.kodexa.ai/api-reference/orchestrator-modules/get-orchestrator-modules-id-sequence.md): Returns the current change sequence number for the specified OrchestratorModule. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get OrchestratorModule by ID](https://developer.kodexa.ai/api-reference/orchestrator-modules/get-orchestratormodule-by-id.md): Retrieves a single OrchestratorModule by its unique identifier. Orchestrator modules are processing components used within pipelines.
- [Get OrchestratorModule change sequence](https://developer.kodexa.ai/api-reference/orchestrator-modules/get-orchestratormodule-change-sequence.md): Returns the current change sequence number for the specified OrchestratorModule. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Orchestrator Modules](https://developer.kodexa.ai/api-reference/orchestrator-modules/list-orchestrator-modules.md): Returns a paginated list of Orchestrator Modules. Orchestrator modules are processing components used within pipelines.
- [Create OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/post-orchestrator-modules.md): Creates a new OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [Update OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/put-orchestrator-modules-id.md): Updates an existing OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [Update OrchestratorModule](https://developer.kodexa.ai/api-reference/orchestrator-modules/update-orchestratormodule.md): Updates an existing OrchestratorModule. Orchestrator modules are processing components used within pipelines.
- [Create Organization](https://developer.kodexa.ai/api-reference/organizations/create-organization.md): Creates a new Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Delete an org secret](https://developer.kodexa.ai/api-reference/organizations/delete-an-org-secret.md)
- [Delete Organization](https://developer.kodexa.ai/api-reference/organizations/delete-organization.md): Permanently deletes the specified Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Delete Organization](https://developer.kodexa.ai/api-reference/organizations/delete-organizations-id.md): Permanently deletes the specified Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Delete an org secret](https://developer.kodexa.ai/api-reference/organizations/delete-organizations-orgId-secrets-secretName.md): Deletes a named secret from an organization, immediately removing the stored value so it can no longer be referenced by assistants or workflows.
- [Get Organization by ID](https://developer.kodexa.ai/api-reference/organizations/get-organization-by-id.md): Retrieves a single Organization by its unique identifier. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Get Organization change sequence](https://developer.kodexa.ai/api-reference/organizations/get-organization-change-sequence.md): Returns the current change sequence number for the specified Organization. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get organization labels](https://developer.kodexa.ai/api-reference/organizations/get-organization-labels.md): Returns all labels defined for the specified organization.
- [Get organization members](https://developer.kodexa.ai/api-reference/organizations/get-organization-members.md): Returns all users who are members of the specified organization via team assignments.
- [List Organizations](https://developer.kodexa.ai/api-reference/organizations/get-organizations.md): Returns a paginated list of Organizations. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Get Organization by ID](https://developer.kodexa.ai/api-reference/organizations/get-organizations-id.md): Retrieves a single Organization by its unique identifier. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [List available modules](https://developer.kodexa.ai/api-reference/organizations/get-organizations-id-available-modules.md): Returns the processing modules available to the specified organization.
- [List available project templates](https://developer.kodexa.ai/api-reference/organizations/get-organizations-id-available-project-templates.md): Returns the project templates available to the specified organization.
- [Get Organization change sequence](https://developer.kodexa.ai/api-reference/organizations/get-organizations-id-sequence.md): Returns the current change sequence number for the specified Organization. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List project templates available to an org](https://developer.kodexa.ai/api-reference/organizations/get-organizations-orgId-available-project-templates.md): Lists the project templates available to a specific organization, including platform-wide templates and any custom templates shared with the org.
- [Get organization labels](https://developer.kodexa.ai/api-reference/organizations/get-organizations-orgId-labels.md): Returns all labels defined for the specified organization.
- [Get organization members](https://developer.kodexa.ai/api-reference/organizations/get-organizations-orgId-members.md): Returns all users who are members of the specified organization via team assignments.
- [List secrets for an org](https://developer.kodexa.ai/api-reference/organizations/get-organizations-orgId-secrets.md): Lists AWS Secrets Manager secrets owned by the organisation. Values are not returned.
- [Reveal an org secret value](https://developer.kodexa.ai/api-reference/organizations/get-organizations-orgId-secrets-secretName-value.md): Returns the secret value. Permission gated; intended for secure server-side use.
- [Invoke LLM](https://developer.kodexa.ai/api-reference/organizations/invoke-llm.md): Invokes the platform LLM for the specified organization. Resolves the prompt template (either from a stored prompt reference or an inline string), renders template parameters, and returns the LLM response as plain text.
- [List available modules](https://developer.kodexa.ai/api-reference/organizations/list-available-modules.md): Returns the processing modules available to the specified organization.
- [List available project templates](https://developer.kodexa.ai/api-reference/organizations/list-available-project-templates.md): Returns the project templates available to the specified organization.
- [List Organizations](https://developer.kodexa.ai/api-reference/organizations/list-organizations.md): Returns a paginated list of Organizations. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [List project templates available to an org](https://developer.kodexa.ai/api-reference/organizations/list-project-templates-available-to-an-org.md)
- [List secrets for an org](https://developer.kodexa.ai/api-reference/organizations/list-secrets-for-an-org.md): Lists AWS Secrets Manager secrets owned by the organisation. Values are not returned.
- [Create Organization](https://developer.kodexa.ai/api-reference/organizations/post-organizations.md): Creates a new Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Invoke LLM](https://developer.kodexa.ai/api-reference/organizations/post-organizations-orgId-llm.md): Invokes the platform LLM for the specified organization. Resolves the prompt template (either from a stored prompt reference or an inline string), renders template parameters, and returns the LLM response as plain text.
- [Store a secret for an org](https://developer.kodexa.ai/api-reference/organizations/post-organizations-orgId-secrets.md): Stores a new named secret for an organization, encrypting the value so it can be safely referenced by name from assistants, actions, and pipelines.
- [Update Organization](https://developer.kodexa.ai/api-reference/organizations/put-organizations-id.md): Updates an existing Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Reveal an org secret value](https://developer.kodexa.ai/api-reference/organizations/reveal-an-org-secret-value.md): Returns the secret value. Permission gated; intended for secure server-side use.
- [Store a secret for an org](https://developer.kodexa.ai/api-reference/organizations/store-a-secret-for-an-org.md)
- [Update Organization](https://developer.kodexa.ai/api-reference/organizations/update-organization.md): Updates an existing Organization. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
- [Get Permission by ID](https://developer.kodexa.ai/api-reference/permissions/get-permission-by-id.md): Retrieves a single Permission by its unique identifier. Permissions define resource:action pairs for fine-grained access control.
- [Get Permission change sequence](https://developer.kodexa.ai/api-reference/permissions/get-permission-change-sequence.md): Returns the current change sequence number for the specified Permission. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Permissions](https://developer.kodexa.ai/api-reference/permissions/get-permissions.md): Returns a paginated list of Permissions. Permissions define resource:action pairs for fine-grained access control.
- [Get Permission by ID](https://developer.kodexa.ai/api-reference/permissions/get-permissions-id.md): Retrieves a single Permission by its unique identifier. Permissions define resource:action pairs for fine-grained access control.
- [Get Permission change sequence](https://developer.kodexa.ai/api-reference/permissions/get-permissions-id-sequence.md): Returns the current change sequence number for the specified Permission. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Permissions](https://developer.kodexa.ai/api-reference/permissions/list-permissions.md): Returns a paginated list of Permissions. Permissions define resource:action pairs for fine-grained access control.
- [Create PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/create-platformconfiguration.md): Creates a new PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [Delete PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/delete-platform-configurations-id.md): Permanently deletes the specified PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [Delete PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/delete-platformconfiguration.md): Permanently deletes the specified PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [List Platform Configuration](https://developer.kodexa.ai/api-reference/platform-configuration/get-platform-configurations.md): Returns a paginated list of Platform Configuration. Platform configurations store platform-wide settings and feature flags.
- [Get PlatformConfiguration by ID](https://developer.kodexa.ai/api-reference/platform-configuration/get-platform-configurations-id.md): Retrieves a single PlatformConfiguration by its unique identifier. Platform configurations store platform-wide settings and feature flags.
- [Get PlatformConfiguration change sequence](https://developer.kodexa.ai/api-reference/platform-configuration/get-platform-configurations-id-sequence.md): Returns the current change sequence number for the specified PlatformConfiguration. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get PlatformConfiguration by ID](https://developer.kodexa.ai/api-reference/platform-configuration/get-platformconfiguration-by-id.md): Retrieves a single PlatformConfiguration by its unique identifier. Platform configurations store platform-wide settings and feature flags.
- [Get PlatformConfiguration change sequence](https://developer.kodexa.ai/api-reference/platform-configuration/get-platformconfiguration-change-sequence.md): Returns the current change sequence number for the specified PlatformConfiguration. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Platform Configuration](https://developer.kodexa.ai/api-reference/platform-configuration/list-platform-configuration.md): Returns a paginated list of Platform Configuration. Platform configurations store platform-wide settings and feature flags.
- [Create PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/post-platform-configurations.md): Creates a new PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [Update PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/put-platform-configurations-id.md): Updates an existing PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [Update PlatformConfiguration](https://developer.kodexa.ai/api-reference/platform-configuration/update-platformconfiguration.md): Updates an existing PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
- [Get platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/get-configuration.md): Returns the public platform configuration including authentication settings, available features, and UI configuration.
- [Get platform overview](https://developer.kodexa.ai/api-reference/platform-overview/get-overview.md): Returns an overview of the Kodexa platform including version information, feature availability, and system status.
- [Get platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/get-platform-configuration.md): Returns the public platform configuration including authentication settings, available features, and UI configuration.
- [Get platform overview](https://developer.kodexa.ai/api-reference/platform-overview/get-platform-overview.md): Returns an overview of the Kodexa platform including version information, feature availability, and system status.
- [Get platform terms and conditions](https://developer.kodexa.ai/api-reference/platform-overview/get-platform-terms-and-conditions.md)
- [Get platform terms and conditions](https://developer.kodexa.ai/api-reference/platform-overview/get-terms.md): Returns the current version of the Kodexa platform terms and conditions, used by clients to present the agreement during user signup and onboarding.
- [Update platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/put-configuration.md): Updates the platform configuration. Requires platform admin role.
- [Reset platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/put-configuration-reset.md): Resets the platform configuration to defaults. Requires platform admin role.
- [Reset platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/reset-platform-configuration.md): Resets the platform configuration to defaults. Requires platform admin role.
- [Update platform configuration](https://developer.kodexa.ai/api-reference/platform-overview/update-platform-configuration.md): Updates the platform configuration. Requires platform admin role.
- [Create ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/create-productgroup.md): Creates a new ProductGroup. Product groups bundle related products together.
- [Delete ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/delete-product-groups-id.md): Permanently deletes the specified ProductGroup. Product groups bundle related products together.
- [Delete ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/delete-productgroup.md): Permanently deletes the specified ProductGroup. Product groups bundle related products together.
- [List Product Groups](https://developer.kodexa.ai/api-reference/product-groups/get-product-groups.md): Returns a paginated list of Product Groups. Product groups bundle related products together.
- [Get ProductGroup by ID](https://developer.kodexa.ai/api-reference/product-groups/get-product-groups-id.md): Retrieves a single ProductGroup by its unique identifier. Product groups bundle related products together.
- [Get ProductGroup change sequence](https://developer.kodexa.ai/api-reference/product-groups/get-product-groups-id-sequence.md): Returns the current change sequence number for the specified ProductGroup. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProductGroup by ID](https://developer.kodexa.ai/api-reference/product-groups/get-productgroup-by-id.md): Retrieves a single ProductGroup by its unique identifier. Product groups bundle related products together.
- [Get ProductGroup change sequence](https://developer.kodexa.ai/api-reference/product-groups/get-productgroup-change-sequence.md): Returns the current change sequence number for the specified ProductGroup. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Product Groups](https://developer.kodexa.ai/api-reference/product-groups/list-product-groups.md): Returns a paginated list of Product Groups. Product groups bundle related products together.
- [Create ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/post-product-groups.md): Creates a new ProductGroup. Product groups bundle related products together.
- [Update ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/put-product-groups-id.md): Updates an existing ProductGroup. Product groups bundle related products together.
- [Update ProductGroup](https://developer.kodexa.ai/api-reference/product-groups/update-productgroup.md): Updates an existing ProductGroup. Product groups bundle related products together.
- [Create Products](https://developer.kodexa.ai/api-reference/product-overview/create-products.md): Creates a new Products. Products represent purchasable offerings on the Kodexa platform.
- [Delete Products](https://developer.kodexa.ai/api-reference/product-overview/delete-products.md): Permanently deletes the specified Products. Products represent purchasable offerings on the Kodexa platform.
- [Delete Products](https://developer.kodexa.ai/api-reference/product-overview/delete-products-id.md): Permanently deletes the specified Products. Products represent purchasable offerings on the Kodexa platform.
- [List Product Overview](https://developer.kodexa.ai/api-reference/product-overview/get-products.md): Returns a paginated list of Product Overview. Products represent purchasable offerings on the Kodexa platform.
- [Get Products by ID](https://developer.kodexa.ai/api-reference/product-overview/get-products-by-id.md): Retrieves a single Products by its unique identifier. Products represent purchasable offerings on the Kodexa platform.
- [Get Products change sequence](https://developer.kodexa.ai/api-reference/product-overview/get-products-change-sequence.md): Returns the current change sequence number for the specified Products. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get Products by ID](https://developer.kodexa.ai/api-reference/product-overview/get-products-id.md): Retrieves a single Products by its unique identifier. Products represent purchasable offerings on the Kodexa platform.
- [Get Products change sequence](https://developer.kodexa.ai/api-reference/product-overview/get-products-id-sequence.md): Returns the current change sequence number for the specified Products. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Product Overview](https://developer.kodexa.ai/api-reference/product-overview/list-product-overview.md): Returns a paginated list of Product Overview. Products represent purchasable offerings on the Kodexa platform.
- [Create Products](https://developer.kodexa.ai/api-reference/product-overview/post-products.md): Creates a new Products. Products represent purchasable offerings on the Kodexa platform.
- [Update Products](https://developer.kodexa.ai/api-reference/product-overview/put-products-id.md): Updates an existing Products. Products represent purchasable offerings on the Kodexa platform.
- [Update Products](https://developer.kodexa.ai/api-reference/product-overview/update-products.md): Updates an existing Products. Products represent purchasable offerings on the Kodexa platform.
- [Create ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/create-productsubscription.md): Creates a new ProductSubscription. Product subscriptions link organizations to purchased products.
- [Delete ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/delete-product-subscriptions-id.md): Permanently deletes the specified ProductSubscription. Product subscriptions link organizations to purchased products.
- [Delete ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/delete-productsubscription.md): Permanently deletes the specified ProductSubscription. Product subscriptions link organizations to purchased products.
- [List Product Subscriptions](https://developer.kodexa.ai/api-reference/product-subscriptions/get-product-subscriptions.md): Returns a paginated list of Product Subscriptions. Product subscriptions link organizations to purchased products.
- [Get ProductSubscription by ID](https://developer.kodexa.ai/api-reference/product-subscriptions/get-product-subscriptions-id.md): Retrieves a single ProductSubscription by its unique identifier. Product subscriptions link organizations to purchased products.
- [Get ProductSubscription change sequence](https://developer.kodexa.ai/api-reference/product-subscriptions/get-product-subscriptions-id-sequence.md): Returns the current change sequence number for the specified ProductSubscription. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProductSubscription by ID](https://developer.kodexa.ai/api-reference/product-subscriptions/get-productsubscription-by-id.md): Retrieves a single ProductSubscription by its unique identifier. Product subscriptions link organizations to purchased products.
- [Get ProductSubscription change sequence](https://developer.kodexa.ai/api-reference/product-subscriptions/get-productsubscription-change-sequence.md): Returns the current change sequence number for the specified ProductSubscription. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Product Subscriptions](https://developer.kodexa.ai/api-reference/product-subscriptions/list-product-subscriptions.md): Returns a paginated list of Product Subscriptions. Product subscriptions link organizations to purchased products.
- [Create ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/post-product-subscriptions.md): Creates a new ProductSubscription. Product subscriptions link organizations to purchased products.
- [Update ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/put-product-subscriptions-id.md): Updates an existing ProductSubscription. Product subscriptions link organizations to purchased products.
- [Update ProductSubscription](https://developer.kodexa.ai/api-reference/product-subscriptions/update-productsubscription.md): Updates an existing ProductSubscription. Product subscriptions link organizations to purchased products.
- [Create ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/create-productprojecttemplate.md): Creates a new ProductProjectTemplate. Product project templates define default project configurations for products.
- [Delete ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/delete-product-project-templates-id.md): Permanently deletes the specified ProductProjectTemplate. Product project templates define default project configurations for products.
- [Delete ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/delete-productprojecttemplate.md): Permanently deletes the specified ProductProjectTemplate. Product project templates define default project configurations for products.
- [List ProductProjectTemplates](https://developer.kodexa.ai/api-reference/productprojecttemplates/get-product-project-templates.md): Returns a paginated list of ProductProjectTemplates. Product project templates define default project configurations for products.
- [Get ProductProjectTemplate by ID](https://developer.kodexa.ai/api-reference/productprojecttemplates/get-product-project-templates-id.md): Retrieves a single ProductProjectTemplate by its unique identifier. Product project templates define default project configurations for products.
- [Get ProductProjectTemplate change sequence](https://developer.kodexa.ai/api-reference/productprojecttemplates/get-product-project-templates-id-sequence.md): Returns the current change sequence number for the specified ProductProjectTemplate. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProductProjectTemplate by ID](https://developer.kodexa.ai/api-reference/productprojecttemplates/get-productprojecttemplate-by-id.md): Retrieves a single ProductProjectTemplate by its unique identifier. Product project templates define default project configurations for products.
- [Get ProductProjectTemplate change sequence](https://developer.kodexa.ai/api-reference/productprojecttemplates/get-productprojecttemplate-change-sequence.md): Returns the current change sequence number for the specified ProductProjectTemplate. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List ProductProjectTemplates](https://developer.kodexa.ai/api-reference/productprojecttemplates/list-productprojecttemplates.md): Returns a paginated list of ProductProjectTemplates. Product project templates define default project configurations for products.
- [Create ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/post-product-project-templates.md): Creates a new ProductProjectTemplate. Product project templates define default project configurations for products.
- [Update ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/put-product-project-templates-id.md): Updates an existing ProductProjectTemplate. Product project templates define default project configurations for products.
- [Update ProductProjectTemplate](https://developer.kodexa.ai/api-reference/productprojecttemplates/update-productprojecttemplate.md): Updates an existing ProductProjectTemplate. Product project templates define default project configurations for products.
- [Bind a resource to a project](https://developer.kodexa.ai/api-reference/project-resources/bind-a-resource-to-a-project.md): Creates an entry in the kdxa_project_resources binding table linking a project to a shared resource (task-template, task-status, etc.).
- [Create ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/create-projectresource.md): Creates a new ProjectResource. Project resources link entities to projects for access control scoping.
- [Delete ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/delete-project-resources-id.md): Permanently deletes the specified ProjectResource. Project resources link entities to projects for access control scoping.
- [Delete ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/delete-projectresource.md): Permanently deletes the specified ProjectResource. Project resources link entities to projects for access control scoping.
- [List Project Resources](https://developer.kodexa.ai/api-reference/project-resources/get-project-resources.md): Returns a paginated list of Project Resources. Project resources link entities to projects for access control scoping.
- [Get ProjectResource by ID](https://developer.kodexa.ai/api-reference/project-resources/get-project-resources-id.md): Retrieves a single ProjectResource by its unique identifier. Project resources link entities to projects for access control scoping.
- [Get ProjectResource change sequence](https://developer.kodexa.ai/api-reference/project-resources/get-project-resources-id-sequence.md): Returns the current change sequence number for the specified ProjectResource. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProjectResource by ID](https://developer.kodexa.ai/api-reference/project-resources/get-projectresource-by-id.md): Retrieves a single ProjectResource by its unique identifier. Project resources link entities to projects for access control scoping.
- [Get ProjectResource change sequence](https://developer.kodexa.ai/api-reference/project-resources/get-projectresource-change-sequence.md): Returns the current change sequence number for the specified ProjectResource. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Project Resources](https://developer.kodexa.ai/api-reference/project-resources/list-project-resources.md): Returns a paginated list of Project Resources. Project resources link entities to projects for access control scoping.
- [Create ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/post-project-resources.md): Creates a new ProjectResource. Project resources link entities to projects for access control scoping.
- [Bind a resource to a project](https://developer.kodexa.ai/api-reference/project-resources/post-project-resources-bind.md): Creates an entry in the kdxa_project_resources binding table linking a project to a shared resource (task-template, task-status, etc.).
- [Update ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/put-project-resources-id.md): Updates an existing ProjectResource. Project resources link entities to projects for access control scoping.
- [Update ProjectResource](https://developer.kodexa.ai/api-reference/project-resources/update-projectresource.md): Updates an existing ProjectResource. Project resources link entities to projects for access control scoping.
- [Create ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/create-projectstatus.md): Creates a new ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [Delete ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/delete-project-statuses-id.md): Permanently deletes the specified ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [Delete ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/delete-projectstatus.md): Permanently deletes the specified ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [List Project Status](https://developer.kodexa.ai/api-reference/project-status/get-project-statuses.md): Returns a paginated list of Project Status. Project statuses define named states for tracking project lifecycle.
- [Get ProjectStatus by ID](https://developer.kodexa.ai/api-reference/project-status/get-project-statuses-id.md): Retrieves a single ProjectStatus by its unique identifier. Project statuses define named states for tracking project lifecycle.
- [Get ProjectStatus change sequence](https://developer.kodexa.ai/api-reference/project-status/get-project-statuses-id-sequence.md): Returns the current change sequence number for the specified ProjectStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProjectStatus by ID](https://developer.kodexa.ai/api-reference/project-status/get-projectstatus-by-id.md): Retrieves a single ProjectStatus by its unique identifier. Project statuses define named states for tracking project lifecycle.
- [Get ProjectStatus change sequence](https://developer.kodexa.ai/api-reference/project-status/get-projectstatus-change-sequence.md): Returns the current change sequence number for the specified ProjectStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Project Status](https://developer.kodexa.ai/api-reference/project-status/list-project-status.md): Returns a paginated list of Project Status. Project statuses define named states for tracking project lifecycle.
- [Create ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/post-project-statuses.md): Creates a new ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [Update ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/put-project-statuses-id.md): Updates an existing ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [Update ProjectStatus](https://developer.kodexa.ai/api-reference/project-status/update-projectstatus.md): Updates an existing ProjectStatus. Project statuses define named states for tracking project lifecycle.
- [Create ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/create-projecttemplatemetadata.md): Creates a new ProjectTemplateMetadata. Project templates define reusable project configurations.
- [Delete ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/delete-project-templates-id.md): Permanently deletes the specified ProjectTemplateMetadata. Project templates define reusable project configurations.
- [Delete ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/delete-projecttemplatemetadata.md): Permanently deletes the specified ProjectTemplateMetadata. Project templates define reusable project configurations.
- [List Project Templates](https://developer.kodexa.ai/api-reference/project-templates/get-project-templates.md): Returns a paginated list of Project Templates. Project templates define reusable project configurations.
- [Get ProjectTemplateMetadata by ID](https://developer.kodexa.ai/api-reference/project-templates/get-project-templates-id.md): Retrieves a single ProjectTemplateMetadata by its unique identifier. Project templates define reusable project configurations.
- [Get ProjectTemplateMetadata change sequence](https://developer.kodexa.ai/api-reference/project-templates/get-project-templates-id-sequence.md): Returns the current change sequence number for the specified ProjectTemplateMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ProjectTemplateMetadata by ID](https://developer.kodexa.ai/api-reference/project-templates/get-projecttemplatemetadata-by-id.md): Retrieves a single ProjectTemplateMetadata by its unique identifier. Project templates define reusable project configurations.
- [Get ProjectTemplateMetadata change sequence](https://developer.kodexa.ai/api-reference/project-templates/get-projecttemplatemetadata-change-sequence.md): Returns the current change sequence number for the specified ProjectTemplateMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Project Templates](https://developer.kodexa.ai/api-reference/project-templates/list-project-templates.md): Returns a paginated list of Project Templates. Project templates define reusable project configurations.
- [Create ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/post-project-templates.md): Creates a new ProjectTemplateMetadata. Project templates define reusable project configurations.
- [Update ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/put-project-templates-id.md): Updates an existing ProjectTemplateMetadata. Project templates define reusable project configurations.
- [Update ProjectTemplateMetadata](https://developer.kodexa.ai/api-reference/project-templates/update-projecttemplatemetadata.md): Updates an existing ProjectTemplateMetadata. Project templates define reusable project configurations.
- [Activate assistant](https://developer.kodexa.ai/api-reference/projects/activate-assistant.md): Activates the specified assistant, enabling it to process documents.
- [Add assistant to project](https://developer.kodexa.ai/api-reference/projects/add-assistant-to-project.md): Adds a new assistant to the specified project.
- [Add data form to project](https://developer.kodexa.ai/api-reference/projects/add-data-form-to-project.md): Associates a data form with the specified project.
- [Create Project](https://developer.kodexa.ai/api-reference/projects/create-project.md): Creates a new Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Create project template request](https://developer.kodexa.ai/api-reference/projects/create-project-template-request.md): Generates a project template request from the current project configuration, which can be used to create a reusable template.
- [Deactivate assistant](https://developer.kodexa.ai/api-reference/projects/deactivate-assistant.md): Deactivates the specified assistant, stopping it from processing documents.
- [Delete Project](https://developer.kodexa.ai/api-reference/projects/delete-project.md): Permanently deletes the specified Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Delete Project](https://developer.kodexa.ai/api-reference/projects/delete-projects-id.md): Permanently deletes the specified Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Remove assistant from project](https://developer.kodexa.ai/api-reference/projects/delete-projects-id-assistants-assistantId.md): Removes a specific assistant from the project.
- [Get assistant event options](https://developer.kodexa.ai/api-reference/projects/get-assistant-event-options.md): Returns the available options for the specified event type on the assistant.
- [Get assistant stores](https://developer.kodexa.ai/api-reference/projects/get-assistant-stores.md): Returns the document stores associated with the specified assistant in the project.
- [Get Project by ID](https://developer.kodexa.ai/api-reference/projects/get-project-by-id.md): Retrieves a single Project by its unique identifier. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Get Project change sequence](https://developer.kodexa.ai/api-reference/projects/get-project-change-sequence.md): Returns the current change sequence number for the specified Project. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get project dashboards](https://developer.kodexa.ai/api-reference/projects/get-project-dashboards.md): Returns the dashboards associated with the specified project.
- [Get project guidance](https://developer.kodexa.ai/api-reference/projects/get-project-guidance.md): Returns the AI extraction guidance associated with the specified project.
- [Get project resources](https://developer.kodexa.ai/api-reference/projects/get-project-resources.md): Returns the resources (stores, taxonomies) associated with the specified project.
- [List Projects](https://developer.kodexa.ai/api-reference/projects/get-projects.md): Returns a paginated list of Projects. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Get Project by ID](https://developer.kodexa.ai/api-reference/projects/get-projects-id.md): Retrieves a single Project by its unique identifier. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [List project assistants](https://developer.kodexa.ai/api-reference/projects/get-projects-id-assistants.md): Returns a paginated list of assistants configured for the specified project.
- [Get assistant event options](https://developer.kodexa.ai/api-reference/projects/get-projects-id-assistants-assistantId-events-eventTypeName-options.md): Returns the available options for the specified event type on the assistant.
- [List assistant executions](https://developer.kodexa.ai/api-reference/projects/get-projects-id-assistants-assistantId-executions.md): Returns a paginated list of executions for the specified assistant.
- [Get assistant stores](https://developer.kodexa.ai/api-reference/projects/get-projects-id-assistants-assistantId-stores.md): Returns the document stores associated with the specified assistant in the project.
- [Create project template request](https://developer.kodexa.ai/api-reference/projects/get-projects-id-create-project-template-request.md): Generates a project template request from the current project configuration, which can be used to create a reusable template.
- [Get project dashboards](https://developer.kodexa.ai/api-reference/projects/get-projects-id-dashboards.md): Returns the dashboards associated with the specified project.
- [List project data forms](https://developer.kodexa.ai/api-reference/projects/get-projects-id-data-forms.md): Returns the data forms associated with the specified project.
- [Get project guidance](https://developer.kodexa.ai/api-reference/projects/get-projects-id-guidance.md): Returns the AI extraction guidance associated with the specified project.
- [Get project resources](https://developer.kodexa.ai/api-reference/projects/get-projects-id-resources.md): Returns the resources (stores, taxonomies) associated with the specified project.
- [Get Project change sequence](https://developer.kodexa.ai/api-reference/projects/get-projects-id-sequence.md): Returns the current change sequence number for the specified Project. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List assistant executions](https://developer.kodexa.ai/api-reference/projects/list-assistant-executions.md): Returns a paginated list of executions for the specified assistant.
- [List project assistants](https://developer.kodexa.ai/api-reference/projects/list-project-assistants.md): Returns a paginated list of assistants configured for the specified project.
- [List project data forms](https://developer.kodexa.ai/api-reference/projects/list-project-data-forms.md): Returns the data forms associated with the specified project.
- [List Projects](https://developer.kodexa.ai/api-reference/projects/list-projects.md): Returns a paginated list of Projects. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Create Project](https://developer.kodexa.ai/api-reference/projects/post-projects.md): Creates a new Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Add assistant to project](https://developer.kodexa.ai/api-reference/projects/post-projects-id-assistants.md): Adds a new assistant to the specified project.
- [Send assistant event](https://developer.kodexa.ai/api-reference/projects/post-projects-id-assistants-assistantId-events.md): Sends an event to the specified assistant for processing.
- [Add data form to project](https://developer.kodexa.ai/api-reference/projects/post-projects-id-data-forms.md): Associates a data form with the specified project.
- [Update Project](https://developer.kodexa.ai/api-reference/projects/put-projects-id.md): Updates an existing Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Update project assistants](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants.md): Updates all assistants for the specified project.
- [Update project assistant](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants-assistantId.md): Updates a specific assistant within the project.
- [Activate assistant](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants-assistantId-activate.md): Activates the specified assistant, enabling it to process documents.
- [Deactivate assistant](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants-assistantId-deactivate.md): Deactivates the specified assistant, stopping it from processing documents.
- [Trigger assistant schedule](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants-assistantId-schedule.md): Triggers a manual execution of the specified assistant's processing schedule.
- [Update assistant stores](https://developer.kodexa.ai/api-reference/projects/put-projects-id-assistants-assistantId-stores.md): Updates the document stores associated with the specified assistant in the project.
- [Update project resources](https://developer.kodexa.ai/api-reference/projects/put-projects-id-resources.md): Updates the resources associated with the specified project.
- [Remove assistant from project](https://developer.kodexa.ai/api-reference/projects/remove-assistant-from-project.md): Removes a specific assistant from the project.
- [Send assistant event](https://developer.kodexa.ai/api-reference/projects/send-assistant-event.md): Sends an event to the specified assistant for processing.
- [Trigger assistant schedule](https://developer.kodexa.ai/api-reference/projects/trigger-assistant-schedule.md): Triggers a manual execution of the specified assistant's processing schedule.
- [Update assistant stores](https://developer.kodexa.ai/api-reference/projects/update-assistant-stores.md): Updates the document stores associated with the specified assistant in the project.
- [Update Project](https://developer.kodexa.ai/api-reference/projects/update-project.md): Updates an existing Project. Projects group related document stores, assistants, tasks, and processing pipelines within an organization.
- [Update project assistant](https://developer.kodexa.ai/api-reference/projects/update-project-assistant.md): Updates a specific assistant within the project.
- [Update project assistants](https://developer.kodexa.ai/api-reference/projects/update-project-assistants.md): Updates all assistants for the specified project.
- [Update project resources](https://developer.kodexa.ai/api-reference/projects/update-project-resources.md): Updates the resources associated with the specified project.
- [Create Prompts](https://developer.kodexa.ai/api-reference/prompts/create-prompts.md): Creates a new Prompts. Prompts are templates used by AI assistants for document processing.
- [Delete Prompts](https://developer.kodexa.ai/api-reference/prompts/delete-prompts.md): Permanently deletes the specified Prompts. Prompts are templates used by AI assistants for document processing.
- [Delete Prompts](https://developer.kodexa.ai/api-reference/prompts/delete-prompts-id.md): Permanently deletes the specified Prompts. Prompts are templates used by AI assistants for document processing.
- [List Prompts](https://developer.kodexa.ai/api-reference/prompts/get-prompts.md): Returns a paginated list of Prompts. Prompts are templates used by AI assistants for document processing.
- [Get Prompts by ID](https://developer.kodexa.ai/api-reference/prompts/get-prompts-by-id.md): Retrieves a single Prompts by its unique identifier. Prompts are templates used by AI assistants for document processing.
- [Get Prompts change sequence](https://developer.kodexa.ai/api-reference/prompts/get-prompts-change-sequence.md): Returns the current change sequence number for the specified Prompts. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get Prompts by ID](https://developer.kodexa.ai/api-reference/prompts/get-prompts-id.md): Retrieves a single Prompts by its unique identifier. Prompts are templates used by AI assistants for document processing.
- [Get Prompts change sequence](https://developer.kodexa.ai/api-reference/prompts/get-prompts-id-sequence.md): Returns the current change sequence number for the specified Prompts. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Prompts](https://developer.kodexa.ai/api-reference/prompts/list-prompts.md): Returns a paginated list of Prompts. Prompts are templates used by AI assistants for document processing.
- [Create Prompts](https://developer.kodexa.ai/api-reference/prompts/post-prompts.md): Creates a new Prompts. Prompts are templates used by AI assistants for document processing.
- [Update Prompts](https://developer.kodexa.ai/api-reference/prompts/put-prompts-id.md): Updates an existing Prompts. Prompts are templates used by AI assistants for document processing.
- [Update Prompts](https://developer.kodexa.ai/api-reference/prompts/update-prompts.md): Updates an existing Prompts. Prompts are templates used by AI assistants for document processing.
- [Create PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/create-purgeitem.md): Creates a new PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [Delete PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/delete-purge-items-id.md): Permanently deletes the specified PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [Delete PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/delete-purgeitem.md): Permanently deletes the specified PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [List Purge Items](https://developer.kodexa.ai/api-reference/purge-items/get-purge-items.md): Returns a paginated list of Purge Items. Purge items mark content for scheduled cleanup and deletion.
- [Get PurgeItem by ID](https://developer.kodexa.ai/api-reference/purge-items/get-purge-items-id.md): Retrieves a single PurgeItem by its unique identifier. Purge items mark content for scheduled cleanup and deletion.
- [Get PurgeItem change sequence](https://developer.kodexa.ai/api-reference/purge-items/get-purge-items-id-sequence.md): Returns the current change sequence number for the specified PurgeItem. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get PurgeItem by ID](https://developer.kodexa.ai/api-reference/purge-items/get-purgeitem-by-id.md): Retrieves a single PurgeItem by its unique identifier. Purge items mark content for scheduled cleanup and deletion.
- [Get PurgeItem change sequence](https://developer.kodexa.ai/api-reference/purge-items/get-purgeitem-change-sequence.md): Returns the current change sequence number for the specified PurgeItem. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Purge Items](https://developer.kodexa.ai/api-reference/purge-items/list-purge-items.md): Returns a paginated list of Purge Items. Purge items mark content for scheduled cleanup and deletion.
- [Create PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/post-purge-items.md): Creates a new PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [Update PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/put-purge-items-id.md): Updates an existing PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [Update PurgeItem](https://developer.kodexa.ai/api-reference/purge-items/update-purgeitem.md): Updates an existing PurgeItem. Purge items mark content for scheduled cleanup and deletion.
- [Create RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/create-recentexecution.md): Creates a new RecentExecution. Recent executions record document processing executions for quick access.
- [Delete RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/delete-recent-executions-id.md): Permanently deletes the specified RecentExecution. Recent executions record document processing executions for quick access.
- [Delete RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/delete-recentexecution.md): Permanently deletes the specified RecentExecution. Recent executions record document processing executions for quick access.
- [List Recent Executions](https://developer.kodexa.ai/api-reference/recent-executions/get-recent-executions.md): Returns a paginated list of Recent Executions. Recent executions record document processing executions for quick access.
- [Get RecentExecution by ID](https://developer.kodexa.ai/api-reference/recent-executions/get-recent-executions-id.md): Retrieves a single RecentExecution by its unique identifier. Recent executions record document processing executions for quick access.
- [Get RecentExecution change sequence](https://developer.kodexa.ai/api-reference/recent-executions/get-recent-executions-id-sequence.md): Returns the current change sequence number for the specified RecentExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get RecentExecution by ID](https://developer.kodexa.ai/api-reference/recent-executions/get-recentexecution-by-id.md): Retrieves a single RecentExecution by its unique identifier. Recent executions record document processing executions for quick access.
- [Get RecentExecution change sequence](https://developer.kodexa.ai/api-reference/recent-executions/get-recentexecution-change-sequence.md): Returns the current change sequence number for the specified RecentExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Recent Executions](https://developer.kodexa.ai/api-reference/recent-executions/list-recent-executions.md): Returns a paginated list of Recent Executions. Recent executions record document processing executions for quick access.
- [Create RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/post-recent-executions.md): Creates a new RecentExecution. Recent executions record document processing executions for quick access.
- [Update RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/put-recent-executions-id.md): Updates an existing RecentExecution. Recent executions record document processing executions for quick access.
- [Update RecentExecution](https://developer.kodexa.ai/api-reference/recent-executions/update-recentexecution.md): Updates an existing RecentExecution. Recent executions record document processing executions for quick access.
- [List supported resource schemes](https://developer.kodexa.ai/api-reference/resource-resolution/get-resolve-schemes.md): Returns the list of supported resource URI schemes. Used by the CLI for discovery of available resource types.
- [List supported resource schemes](https://developer.kodexa.ai/api-reference/resource-resolution/list-supported-resource-schemes.md): Returns the list of supported resource URI schemes. Used by the CLI for discovery of available resource types.
- [Resolve resource URI](https://developer.kodexa.ai/api-reference/resource-resolution/post-resolve.md): Resolves a semantic resource URI (slug-based) into a concrete API path (ID-based). Supported URI format: `scheme://orgSlug/slug`. Supported schemes: module, model, model-runtime, store, document-store, data-store, taxonomy, data-definition, project-template, prompt, data-form.
- [Resolve resource URI](https://developer.kodexa.ai/api-reference/resource-resolution/resolve-resource-uri.md): Resolves a semantic resource URI (slug-based) into a concrete API path (ID-based). Supported URI format: `scheme://orgSlug/slug`. Supported schemes: module, model, model-runtime, store, document-store, data-store, taxonomy, data-definition, project-template, prompt, data-form.
- [Create RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/create-rolepermission.md): Creates a new RolePermission. Role permissions link roles to their granted permissions.
- [Delete RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/delete-role-permissions-id.md): Permanently deletes the specified RolePermission. Role permissions link roles to their granted permissions.
- [Delete RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/delete-rolepermission.md): Permanently deletes the specified RolePermission. Role permissions link roles to their granted permissions.
- [List Role Permissions](https://developer.kodexa.ai/api-reference/role-permissions/get-role-permissions.md): Returns a paginated list of Role Permissions. Role permissions link roles to their granted permissions.
- [Get RolePermission by ID](https://developer.kodexa.ai/api-reference/role-permissions/get-role-permissions-id.md): Retrieves a single RolePermission by its unique identifier. Role permissions link roles to their granted permissions.
- [Get RolePermission change sequence](https://developer.kodexa.ai/api-reference/role-permissions/get-role-permissions-id-sequence.md): Returns the current change sequence number for the specified RolePermission. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get RolePermission by ID](https://developer.kodexa.ai/api-reference/role-permissions/get-rolepermission-by-id.md): Retrieves a single RolePermission by its unique identifier. Role permissions link roles to their granted permissions.
- [Get RolePermission change sequence](https://developer.kodexa.ai/api-reference/role-permissions/get-rolepermission-change-sequence.md): Returns the current change sequence number for the specified RolePermission. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Role Permissions](https://developer.kodexa.ai/api-reference/role-permissions/list-role-permissions.md): Returns a paginated list of Role Permissions. Role permissions link roles to their granted permissions.
- [Create RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/post-role-permissions.md): Creates a new RolePermission. Role permissions link roles to their granted permissions.
- [Update RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/put-role-permissions-id.md): Updates an existing RolePermission. Role permissions link roles to their granted permissions.
- [Update RolePermission](https://developer.kodexa.ai/api-reference/role-permissions/update-rolepermission.md): Updates an existing RolePermission. Role permissions link roles to their granted permissions.
- [Create AccessRole](https://developer.kodexa.ai/api-reference/roles/create-accessrole.md): Creates a new AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Delete AccessRole](https://developer.kodexa.ai/api-reference/roles/delete-accessrole.md): Permanently deletes the specified AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Delete AccessRole](https://developer.kodexa.ai/api-reference/roles/delete-roles-id.md): Permanently deletes the specified AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Get AccessRole by ID](https://developer.kodexa.ai/api-reference/roles/get-accessrole-by-id.md): Retrieves a single AccessRole by its unique identifier. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Get AccessRole change sequence](https://developer.kodexa.ai/api-reference/roles/get-accessrole-change-sequence.md): Returns the current change sequence number for the specified AccessRole. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Roles](https://developer.kodexa.ai/api-reference/roles/get-roles.md): Returns a paginated list of Roles. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Get AccessRole by ID](https://developer.kodexa.ai/api-reference/roles/get-roles-id.md): Retrieves a single AccessRole by its unique identifier. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Get AccessRole change sequence](https://developer.kodexa.ai/api-reference/roles/get-roles-id-sequence.md): Returns the current change sequence number for the specified AccessRole. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Roles](https://developer.kodexa.ai/api-reference/roles/list-roles.md): Returns a paginated list of Roles. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Create AccessRole](https://developer.kodexa.ai/api-reference/roles/post-roles.md): Creates a new AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Update AccessRole](https://developer.kodexa.ai/api-reference/roles/put-roles-id.md): Updates an existing AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Update AccessRole](https://developer.kodexa.ai/api-reference/roles/update-accessrole.md): Updates an existing AccessRole. Roles define sets of permissions that can be assigned to teams at org or project level.
- [Create ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/create-scheduledjobexecution.md): Creates a new ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [Delete ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/delete-scheduled-job-executions-id.md): Permanently deletes the specified ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [Delete ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/delete-scheduledjobexecution.md): Permanently deletes the specified ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [List Scheduled Job Executions](https://developer.kodexa.ai/api-reference/scheduled-job-executions/get-scheduled-job-executions.md): Returns a paginated list of Scheduled Job Executions. Scheduled job executions record individual runs of scheduled jobs.
- [Get ScheduledJobExecution by ID](https://developer.kodexa.ai/api-reference/scheduled-job-executions/get-scheduled-job-executions-id.md): Retrieves a single ScheduledJobExecution by its unique identifier. Scheduled job executions record individual runs of scheduled jobs.
- [Get ScheduledJobExecution change sequence](https://developer.kodexa.ai/api-reference/scheduled-job-executions/get-scheduled-job-executions-id-sequence.md): Returns the current change sequence number for the specified ScheduledJobExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ScheduledJobExecution by ID](https://developer.kodexa.ai/api-reference/scheduled-job-executions/get-scheduledjobexecution-by-id.md): Retrieves a single ScheduledJobExecution by its unique identifier. Scheduled job executions record individual runs of scheduled jobs.
- [Get ScheduledJobExecution change sequence](https://developer.kodexa.ai/api-reference/scheduled-job-executions/get-scheduledjobexecution-change-sequence.md): Returns the current change sequence number for the specified ScheduledJobExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Scheduled Job Executions](https://developer.kodexa.ai/api-reference/scheduled-job-executions/list-scheduled-job-executions.md): Returns a paginated list of Scheduled Job Executions. Scheduled job executions record individual runs of scheduled jobs.
- [Create ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/post-scheduled-job-executions.md): Creates a new ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [Update ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/put-scheduled-job-executions-id.md): Updates an existing ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [Update ScheduledJobExecution](https://developer.kodexa.ai/api-reference/scheduled-job-executions/update-scheduledjobexecution.md): Updates an existing ScheduledJobExecution. Scheduled job executions record individual runs of scheduled jobs.
- [Create ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/create-scheduledjobschedule.md): Creates a new ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Delete ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/delete-scheduled-job-schedules-id.md): Permanently deletes the specified ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Delete ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/delete-scheduledjobschedule.md): Permanently deletes the specified ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [List Scheduled Job Schedules](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/get-scheduled-job-schedules.md): Returns a paginated list of Scheduled Job Schedules. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Get ScheduledJobSchedule by ID](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/get-scheduled-job-schedules-id.md): Retrieves a single ScheduledJobSchedule by its unique identifier. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Get ScheduledJobSchedule change sequence](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/get-scheduled-job-schedules-id-sequence.md): Returns the current change sequence number for the specified ScheduledJobSchedule. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ScheduledJobSchedule by ID](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/get-scheduledjobschedule-by-id.md): Retrieves a single ScheduledJobSchedule by its unique identifier. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Get ScheduledJobSchedule change sequence](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/get-scheduledjobschedule-change-sequence.md): Returns the current change sequence number for the specified ScheduledJobSchedule. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Scheduled Job Schedules](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/list-scheduled-job-schedules.md): Returns a paginated list of Scheduled Job Schedules. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Create ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/post-scheduled-job-schedules.md): Creates a new ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Update ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/put-scheduled-job-schedules-id.md): Updates an existing ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Update ScheduledJobSchedule](https://developer.kodexa.ai/api-reference/scheduled-job-schedules/update-scheduledjobschedule.md): Updates an existing ScheduledJobSchedule. Scheduled job schedules define when scheduled jobs should run using cron expressions.
- [Create ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/create-scheduledjob.md): Creates a new ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [Delete ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/delete-scheduled-jobs-id.md): Permanently deletes the specified ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [Delete ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/delete-scheduledjob.md): Permanently deletes the specified ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [List Scheduled Jobs](https://developer.kodexa.ai/api-reference/scheduled-jobs/get-scheduled-jobs.md): Returns a paginated list of Scheduled Jobs. Scheduled jobs automate document processing on a recurring basis.
- [Get ScheduledJob by ID](https://developer.kodexa.ai/api-reference/scheduled-jobs/get-scheduled-jobs-id.md): Retrieves a single ScheduledJob by its unique identifier. Scheduled jobs automate document processing on a recurring basis.
- [Get ScheduledJob change sequence](https://developer.kodexa.ai/api-reference/scheduled-jobs/get-scheduled-jobs-id-sequence.md): Returns the current change sequence number for the specified ScheduledJob. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ScheduledJob by ID](https://developer.kodexa.ai/api-reference/scheduled-jobs/get-scheduledjob-by-id.md): Retrieves a single ScheduledJob by its unique identifier. Scheduled jobs automate document processing on a recurring basis.
- [Get ScheduledJob change sequence](https://developer.kodexa.ai/api-reference/scheduled-jobs/get-scheduledjob-change-sequence.md): Returns the current change sequence number for the specified ScheduledJob. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Scheduled Jobs](https://developer.kodexa.ai/api-reference/scheduled-jobs/list-scheduled-jobs.md): Returns a paginated list of Scheduled Jobs. Scheduled jobs automate document processing on a recurring basis.
- [Create ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/post-scheduled-jobs.md): Creates a new ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [Update ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/put-scheduled-jobs-id.md): Updates an existing ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [Update ScheduledJob](https://developer.kodexa.ai/api-reference/scheduled-jobs/update-scheduledjob.md): Updates an existing ScheduledJob. Scheduled jobs automate document processing on a recurring basis.
- [Create ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/create-servicebridgemetadata.md): Creates a new ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Delete ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/delete-service-bridges-id.md): Permanently deletes the specified ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Proxy a DELETE request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/delete-service-bridges-id-proxy-endpointName.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Delete ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/delete-servicebridgemetadata.md): Permanently deletes the specified ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [List Service Bridges](https://developer.kodexa.ai/api-reference/service-bridges/get-service-bridges.md): Returns a paginated list of Service Bridges. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Get ServiceBridgeMetadata by ID](https://developer.kodexa.ai/api-reference/service-bridges/get-service-bridges-id.md): Retrieves a single ServiceBridgeMetadata by its unique identifier. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Proxy a GET request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/get-service-bridges-id-proxy-endpointName.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Get ServiceBridgeMetadata change sequence](https://developer.kodexa.ai/api-reference/service-bridges/get-service-bridges-id-sequence.md): Returns the current change sequence number for the specified ServiceBridgeMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get ServiceBridgeMetadata by ID](https://developer.kodexa.ai/api-reference/service-bridges/get-servicebridgemetadata-by-id.md): Retrieves a single ServiceBridgeMetadata by its unique identifier. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Get ServiceBridgeMetadata change sequence](https://developer.kodexa.ai/api-reference/service-bridges/get-servicebridgemetadata-change-sequence.md): Returns the current change sequence number for the specified ServiceBridgeMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Service Bridges](https://developer.kodexa.ai/api-reference/service-bridges/list-service-bridges.md): Returns a paginated list of Service Bridges. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Create ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/post-service-bridges.md): Creates a new ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Proxy a POST request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/post-service-bridges-id-proxy-endpointName.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Proxy request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/proxy-request-through-a-service-bridge-endpoint.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Proxy request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/proxy-request-through-a-service-bridge-endpoint-1.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Proxy request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/proxy-request-through-a-service-bridge-endpoint-2.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Proxy request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/proxy-request-through-a-service-bridge-endpoint-3.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Proxy request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/proxy-request-through-a-service-bridge-endpoint-4.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Update ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/put-service-bridges-id.md): Updates an existing ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Proxy a PUT request through a service bridge endpoint](https://developer.kodexa.ai/api-reference/service-bridges/put-service-bridges-id-proxy-endpointName.md): Forwards the incoming request to the configured external API behind the service bridge, applying the bridge's auth + headers.
- [Update ServiceBridgeMetadata](https://developer.kodexa.ai/api-reference/service-bridges/update-servicebridgemetadata.md): Updates an existing ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
- [Create Session](https://developer.kodexa.ai/api-reference/sessions/create-session.md): Creates a new Session. Sessions represent processing sessions for document operations.
- [Delete Session](https://developer.kodexa.ai/api-reference/sessions/delete-session.md): Permanently deletes the specified Session. Sessions represent processing sessions for document operations.
- [Delete Session](https://developer.kodexa.ai/api-reference/sessions/delete-sessions-id.md): Permanently deletes the specified Session. Sessions represent processing sessions for document operations.
- [Get Session by ID](https://developer.kodexa.ai/api-reference/sessions/get-session-by-id.md): Retrieves a single Session by its unique identifier. Sessions represent processing sessions for document operations.
- [Get Session change sequence](https://developer.kodexa.ai/api-reference/sessions/get-session-change-sequence.md): Returns the current change sequence number for the specified Session. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Sessions](https://developer.kodexa.ai/api-reference/sessions/get-sessions.md): Returns a paginated list of Sessions. Sessions represent processing sessions for document operations.
- [Get Session by ID](https://developer.kodexa.ai/api-reference/sessions/get-sessions-id.md): Retrieves a single Session by its unique identifier. Sessions represent processing sessions for document operations.
- [Get Session change sequence](https://developer.kodexa.ai/api-reference/sessions/get-sessions-id-sequence.md): Returns the current change sequence number for the specified Session. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Sessions](https://developer.kodexa.ai/api-reference/sessions/list-sessions.md): Returns a paginated list of Sessions. Sessions represent processing sessions for document operations.
- [Create Session](https://developer.kodexa.ai/api-reference/sessions/post-sessions.md): Creates a new Session. Sessions represent processing sessions for document operations.
- [Update Session](https://developer.kodexa.ai/api-reference/sessions/put-sessions-id.md): Updates an existing Session. Sessions represent processing sessions for document operations.
- [Update Session](https://developer.kodexa.ai/api-reference/sessions/update-session.md): Updates an existing Session. Sessions represent processing sessions for document operations.
- [Create StepExecution](https://developer.kodexa.ai/api-reference/step-executions/create-stepexecution.md): Creates a new StepExecution. Step executions record results of individual processing steps within execution slices.
- [Delete StepExecution](https://developer.kodexa.ai/api-reference/step-executions/delete-step-executions-id.md): Permanently deletes the specified StepExecution. Step executions record results of individual processing steps within execution slices.
- [Delete StepExecution](https://developer.kodexa.ai/api-reference/step-executions/delete-stepexecution.md): Permanently deletes the specified StepExecution. Step executions record results of individual processing steps within execution slices.
- [List Step Executions](https://developer.kodexa.ai/api-reference/step-executions/get-step-executions.md): Returns a paginated list of Step Executions. Step executions record results of individual processing steps within execution slices.
- [Get StepExecution by ID](https://developer.kodexa.ai/api-reference/step-executions/get-step-executions-id.md): Retrieves a single StepExecution by its unique identifier. Step executions record results of individual processing steps within execution slices.
- [Get StepExecution change sequence](https://developer.kodexa.ai/api-reference/step-executions/get-step-executions-id-sequence.md): Returns the current change sequence number for the specified StepExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get StepExecution by ID](https://developer.kodexa.ai/api-reference/step-executions/get-stepexecution-by-id.md): Retrieves a single StepExecution by its unique identifier. Step executions record results of individual processing steps within execution slices.
- [Get StepExecution change sequence](https://developer.kodexa.ai/api-reference/step-executions/get-stepexecution-change-sequence.md): Returns the current change sequence number for the specified StepExecution. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Step Executions](https://developer.kodexa.ai/api-reference/step-executions/list-step-executions.md): Returns a paginated list of Step Executions. Step executions record results of individual processing steps within execution slices.
- [Create StepExecution](https://developer.kodexa.ai/api-reference/step-executions/post-step-executions.md): Creates a new StepExecution. Step executions record results of individual processing steps within execution slices.
- [Update StepExecution](https://developer.kodexa.ai/api-reference/step-executions/put-step-executions-id.md): Updates an existing StepExecution. Step executions record results of individual processing steps within execution slices.
- [Update StepExecution](https://developer.kodexa.ai/api-reference/step-executions/update-stepexecution.md): Updates an existing StepExecution. Step executions record results of individual processing steps within execution slices.
- [Create TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/create-tagmetadata.md): Creates a new TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [Delete TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/delete-tag-metadata-id.md): Permanently deletes the specified TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [Delete TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/delete-tagmetadata.md): Permanently deletes the specified TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [List Tag Metadata](https://developer.kodexa.ai/api-reference/tag-metadata/get-tag-metadata.md): Returns a paginated list of Tag Metadata. Tag metadata defines tag types for document labeling and categorization.
- [Get TagMetadata by ID](https://developer.kodexa.ai/api-reference/tag-metadata/get-tag-metadata-id.md): Retrieves a single TagMetadata by its unique identifier. Tag metadata defines tag types for document labeling and categorization.
- [Get TagMetadata change sequence](https://developer.kodexa.ai/api-reference/tag-metadata/get-tag-metadata-id-sequence.md): Returns the current change sequence number for the specified TagMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TagMetadata by ID](https://developer.kodexa.ai/api-reference/tag-metadata/get-tagmetadata-by-id.md): Retrieves a single TagMetadata by its unique identifier. Tag metadata defines tag types for document labeling and categorization.
- [Get TagMetadata change sequence](https://developer.kodexa.ai/api-reference/tag-metadata/get-tagmetadata-change-sequence.md): Returns the current change sequence number for the specified TagMetadata. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Tag Metadata](https://developer.kodexa.ai/api-reference/tag-metadata/list-tag-metadata.md): Returns a paginated list of Tag Metadata. Tag metadata defines tag types for document labeling and categorization.
- [Create TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/post-tag-metadata.md): Creates a new TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [Update TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/put-tag-metadata-id.md): Updates an existing TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [Update TagMetadata](https://developer.kodexa.ai/api-reference/tag-metadata/update-tagmetadata.md): Updates an existing TagMetadata. Tag metadata defines tag types for document labeling and categorization.
- [Add tasks to a task group](https://developer.kodexa.ai/api-reference/task-groups/add-tasks-to-a-task-group.md): Adds the given tasks to the task group, stamping each task's task_group_id. If the group has an assignee, it cascades to the new tasks.
- [Assign a task group](https://developer.kodexa.ai/api-reference/task-groups/assign-a-task-group.md): Sets the assignee for a task group and cascades the same assignee to every non-deleted member task atomically.
- [Clear the task-group assignee](https://developer.kodexa.ai/api-reference/task-groups/clear-the-task-group-assignee.md): Clears the assignee on the task group and cascades the null assignee to every member task.
- [Create a task group](https://developer.kodexa.ai/api-reference/task-groups/create-a-task-group.md): Creates a task group within a project and optionally stamps an initial set of tasks with group membership.
- [Delete a task group](https://developer.kodexa.ai/api-reference/task-groups/delete-a-task-group.md): Soft-deletes a task group and ungroups its member tasks. Fails if any member task is locked.
- [Delete a task group](https://developer.kodexa.ai/api-reference/task-groups/delete-task-groups-id.md): Soft-deletes a task group and ungroups its member tasks. Fails if any member task is locked.
- [Clear the task-group assignee](https://developer.kodexa.ai/api-reference/task-groups/delete-task-groups-id-assignee.md): Clears the assignee on the task group and cascades the null assignee to every member task.
- [Remove a task from a task group](https://developer.kodexa.ai/api-reference/task-groups/delete-task-groups-id-tasks-taskId.md): Removes a single task from the task group (clearing task_group_id on that task) and decrements the group's counters.
- [List Task Groups](https://developer.kodexa.ai/api-reference/task-groups/get-task-groups.md): Returns a paginated list of Task Groups. Task groups bundle multiple tasks into a single unit of assignment.
- [Get TaskGroup by ID](https://developer.kodexa.ai/api-reference/task-groups/get-task-groups-id.md): Retrieves a single TaskGroup by its unique identifier. Task groups bundle multiple tasks into a single unit of assignment.
- [List task-group history](https://developer.kodexa.ai/api-reference/task-groups/get-task-groups-id-history.md): Returns the audit trail of lifecycle events (created, assigned, status changed, completed, etc.) for the given task group.
- [Get TaskGroup change sequence](https://developer.kodexa.ai/api-reference/task-groups/get-task-groups-id-sequence.md): Returns the current change sequence number for the specified TaskGroup. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskGroup by ID](https://developer.kodexa.ai/api-reference/task-groups/get-taskgroup-by-id.md): Retrieves a single TaskGroup by its unique identifier. Task groups bundle multiple tasks into a single unit of assignment.
- [Get TaskGroup change sequence](https://developer.kodexa.ai/api-reference/task-groups/get-taskgroup-change-sequence.md): Returns the current change sequence number for the specified TaskGroup. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List task-group history](https://developer.kodexa.ai/api-reference/task-groups/list-task-group-history.md): Returns the audit trail of lifecycle events (created, assigned, status changed, completed, etc.) for the given task group.
- [List Task Groups](https://developer.kodexa.ai/api-reference/task-groups/list-task-groups.md): Returns a paginated list of Task Groups. Task groups bundle multiple tasks into a single unit of assignment.
- [Create a task group](https://developer.kodexa.ai/api-reference/task-groups/post-task-groups.md): Creates a task group within a project and optionally stamps an initial set of tasks with group membership.
- [Add tasks to a task group](https://developer.kodexa.ai/api-reference/task-groups/post-task-groups-id-tasks.md): Adds the given tasks to the task group, stamping each task's task_group_id. If the group has an assignee, it cascades to the new tasks.
- [Update a task group](https://developer.kodexa.ai/api-reference/task-groups/put-task-groups-id.md): Updates the mutable fields of a task group. The assigneeId field is rejected here — use PUT /task-groups/{id}/assignee for assignment changes (which cascade to member tasks).
- [Assign a task group](https://developer.kodexa.ai/api-reference/task-groups/put-task-groups-id-assignee.md): Sets the assignee for a task group and cascades the same assignee to every non-deleted member task atomically.
- [Remove a task from a task group](https://developer.kodexa.ai/api-reference/task-groups/remove-a-task-from-a-task-group.md): Removes a single task from the task group (clearing task_group_id on that task) and decrements the group's counters.
- [Update a task group](https://developer.kodexa.ai/api-reference/task-groups/update-a-task-group.md): Updates the mutable fields of a task group. The assigneeId field is rejected here — use PUT /task-groups/{id}/assignee for assignment changes (which cascade to member tasks).
- [Create TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/create-taskstatus.md): Creates a new TaskStatus. Task statuses define named states for tracking task workflow progress.
- [Delete TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/delete-task-statuses-id.md): Permanently deletes the specified TaskStatus. Task statuses define named states for tracking task workflow progress.
- [Delete TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/delete-taskstatus.md): Permanently deletes the specified TaskStatus. Task statuses define named states for tracking task workflow progress.
- [List Task Statuses](https://developer.kodexa.ai/api-reference/task-statuses/get-task-statuses.md): Returns a paginated list of Task Statuses. Task statuses define named states for tracking task workflow progress.
- [Get TaskStatus by ID](https://developer.kodexa.ai/api-reference/task-statuses/get-task-statuses-id.md): Retrieves a single TaskStatus by its unique identifier. Task statuses define named states for tracking task workflow progress.
- [Get TaskStatus change sequence](https://developer.kodexa.ai/api-reference/task-statuses/get-task-statuses-id-sequence.md): Returns the current change sequence number for the specified TaskStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskStatus by ID](https://developer.kodexa.ai/api-reference/task-statuses/get-taskstatus-by-id.md): Retrieves a single TaskStatus by its unique identifier. Task statuses define named states for tracking task workflow progress.
- [Get TaskStatus change sequence](https://developer.kodexa.ai/api-reference/task-statuses/get-taskstatus-change-sequence.md): Returns the current change sequence number for the specified TaskStatus. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Task Statuses](https://developer.kodexa.ai/api-reference/task-statuses/list-task-statuses.md): Returns a paginated list of Task Statuses. Task statuses define named states for tracking task workflow progress.
- [Create TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/post-task-statuses.md): Creates a new TaskStatus. Task statuses define named states for tracking task workflow progress.
- [Update TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/put-task-statuses-id.md): Updates an existing TaskStatus. Task statuses define named states for tracking task workflow progress.
- [Update TaskStatus](https://developer.kodexa.ai/api-reference/task-statuses/update-taskstatus.md): Updates an existing TaskStatus. Task statuses define named states for tracking task workflow progress.
- [Create TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/create-taskactivity.md): Creates a new TaskActivity. Task activities record events in a task's history such as status changes.
- [Delete TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/delete-task-activities-id.md): Permanently deletes the specified TaskActivity. Task activities record events in a task's history such as status changes.
- [Delete TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/delete-taskactivity.md): Permanently deletes the specified TaskActivity. Task activities record events in a task's history such as status changes.
- [List TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/get-task-activities.md): Returns a paginated list of TaskActivity. Task activities record events in a task's history such as status changes.
- [Get TaskActivity by ID](https://developer.kodexa.ai/api-reference/taskactivity/get-task-activities-id.md): Retrieves a single TaskActivity by its unique identifier. Task activities record events in a task's history such as status changes.
- [Get TaskActivity change sequence](https://developer.kodexa.ai/api-reference/taskactivity/get-task-activities-id-sequence.md): Returns the current change sequence number for the specified TaskActivity. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskActivity by ID](https://developer.kodexa.ai/api-reference/taskactivity/get-taskactivity-by-id.md): Retrieves a single TaskActivity by its unique identifier. Task activities record events in a task's history such as status changes.
- [Get TaskActivity change sequence](https://developer.kodexa.ai/api-reference/taskactivity/get-taskactivity-change-sequence.md): Returns the current change sequence number for the specified TaskActivity. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/list-taskactivity.md): Returns a paginated list of TaskActivity. Task activities record events in a task's history such as status changes.
- [Create TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/post-task-activities.md): Creates a new TaskActivity. Task activities record events in a task's history such as status changes.
- [Update TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/put-task-activities-id.md): Updates an existing TaskActivity. Task activities record events in a task's history such as status changes.
- [Update TaskActivity](https://developer.kodexa.ai/api-reference/taskactivity/update-taskactivity.md): Updates an existing TaskActivity. Task activities record events in a task's history such as status changes.
- [Create TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/create-taskdocumentfamily.md): Creates a new TaskDocumentFamily. Task document families associate document families with tasks for review.
- [Delete TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/delete-task-document-families-id.md): Permanently deletes the specified TaskDocumentFamily. Task document families associate document families with tasks for review.
- [Delete TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/delete-taskdocumentfamily.md): Permanently deletes the specified TaskDocumentFamily. Task document families associate document families with tasks for review.
- [List TaskDocumentFamilies](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/get-task-document-families.md): Returns a paginated list of TaskDocumentFamilies. Task document families associate document families with tasks for review.
- [Get TaskDocumentFamily by ID](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/get-task-document-families-id.md): Retrieves a single TaskDocumentFamily by its unique identifier. Task document families associate document families with tasks for review.
- [Get TaskDocumentFamily change sequence](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/get-task-document-families-id-sequence.md): Returns the current change sequence number for the specified TaskDocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskDocumentFamily by ID](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/get-taskdocumentfamily-by-id.md): Retrieves a single TaskDocumentFamily by its unique identifier. Task document families associate document families with tasks for review.
- [Get TaskDocumentFamily change sequence](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/get-taskdocumentfamily-change-sequence.md): Returns the current change sequence number for the specified TaskDocumentFamily. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List TaskDocumentFamilies](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/list-taskdocumentfamilies.md): Returns a paginated list of TaskDocumentFamilies. Task document families associate document families with tasks for review.
- [Create TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/post-task-document-families.md): Creates a new TaskDocumentFamily. Task document families associate document families with tasks for review.
- [Update TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/put-task-document-families-id.md): Updates an existing TaskDocumentFamily. Task document families associate document families with tasks for review.
- [Update TaskDocumentFamily](https://developer.kodexa.ai/api-reference/taskdocumentfamilies/update-taskdocumentfamily.md): Updates an existing TaskDocumentFamily. Task document families associate document families with tasks for review.
- [Create TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/create-taskgrouphistory.md): Creates a new TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Delete TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/delete-task-group-history-id.md): Permanently deletes the specified TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Delete TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/delete-taskgrouphistory.md): Permanently deletes the specified TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [List TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/get-task-group-history.md): Returns a paginated list of TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Get TaskGroupHistory by ID](https://developer.kodexa.ai/api-reference/taskgrouphistory/get-task-group-history-id.md): Retrieves a single TaskGroupHistory by its unique identifier. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Get TaskGroupHistory change sequence](https://developer.kodexa.ai/api-reference/taskgrouphistory/get-task-group-history-id-sequence.md): Returns the current change sequence number for the specified TaskGroupHistory. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskGroupHistory by ID](https://developer.kodexa.ai/api-reference/taskgrouphistory/get-taskgrouphistory-by-id.md): Retrieves a single TaskGroupHistory by its unique identifier. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Get TaskGroupHistory change sequence](https://developer.kodexa.ai/api-reference/taskgrouphistory/get-taskgrouphistory-change-sequence.md): Returns the current change sequence number for the specified TaskGroupHistory. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/list-taskgrouphistory.md): Returns a paginated list of TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Create TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/post-task-group-history.md): Creates a new TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Update TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/put-task-group-history-id.md): Updates an existing TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Update TaskGroupHistory](https://developer.kodexa.ai/api-reference/taskgrouphistory/update-taskgrouphistory.md): Updates an existing TaskGroupHistory. Audit feed entries for task groups (created, assigned, status changed, completed, etc).
- [Assign next available task](https://developer.kodexa.ai/api-reference/tasks/assign-next-available-task.md): Finds the next unassigned task matching the given filter and assigns it to the current user. Tasks are prioritized by priority (ascending) then creation date (ascending).
- [Clear task assignee](https://developer.kodexa.ai/api-reference/tasks/clear-task-assignee.md): Removes the assignee from the specified task.
- [Clear task status](https://developer.kodexa.ai/api-reference/tasks/clear-task-status.md): Removes the status from the specified task, resetting it to unset.
- [Clear task team](https://developer.kodexa.ai/api-reference/tasks/clear-task-team.md): Removes the team from the specified task.
- [Create Task](https://developer.kodexa.ai/api-reference/tasks/create-task.md): Creates a new Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Create task with request](https://developer.kodexa.ai/api-reference/tasks/create-task-with-request.md): Creates a new task with a full request body including document families, assignees, and other configuration.
- [Delete Task](https://developer.kodexa.ai/api-reference/tasks/delete-task.md): Permanently deletes the specified Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Delete Task](https://developer.kodexa.ai/api-reference/tasks/delete-tasks-id.md): Permanently deletes the specified Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Clear task assignee](https://developer.kodexa.ai/api-reference/tasks/delete-tasks-id-assignee.md): Removes the assignee from the specified task.
- [Clear task status](https://developer.kodexa.ai/api-reference/tasks/delete-tasks-id-status.md): Removes the status from the specified task, resetting it to unset.
- [Clear task team](https://developer.kodexa.ai/api-reference/tasks/delete-tasks-id-team.md): Removes the team from the specified task.
- [Get Task by ID](https://developer.kodexa.ai/api-reference/tasks/get-task-by-id.md): Retrieves a single Task by its unique identifier. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Get Task change sequence](https://developer.kodexa.ai/api-reference/tasks/get-task-change-sequence.md): Returns the current change sequence number for the specified Task. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Tasks](https://developer.kodexa.ai/api-reference/tasks/get-tasks.md): Returns a paginated list of Tasks. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Get Task by ID](https://developer.kodexa.ai/api-reference/tasks/get-tasks-id.md): Retrieves a single Task by its unique identifier. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Get Task change sequence](https://developer.kodexa.ai/api-reference/tasks/get-tasks-id-sequence.md): Returns the current change sequence number for the specified Task. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Tasks](https://developer.kodexa.ai/api-reference/tasks/list-tasks.md): Returns a paginated list of Tasks. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Lock task](https://developer.kodexa.ai/api-reference/tasks/lock-task.md): Locks a task to prevent editing or deletion. Also locks all associated document families.
- [Create Task](https://developer.kodexa.ai/api-reference/tasks/post-tasks.md): Creates a new Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Assign next available task](https://developer.kodexa.ai/api-reference/tasks/post-tasks-assign-next.md): Finds the next unassigned task matching the given filter and assigns it to the current user. Tasks are prioritized by priority (ascending) then creation date (ascending).
- [Create task with request](https://developer.kodexa.ai/api-reference/tasks/post-tasks-create-task-with-request.md): Creates a new task with a full request body including document families, assignees, and other configuration.
- [Lock task](https://developer.kodexa.ai/api-reference/tasks/post-tasks-id-lock.md): Locks a task to prevent editing or deletion. Also locks all associated document families.
- [Unlock task](https://developer.kodexa.ai/api-reference/tasks/post-tasks-id-unlock.md): Unlocks a task to allow editing and deletion. Also unlocks all associated document families.
- [Update Task](https://developer.kodexa.ai/api-reference/tasks/put-tasks-id.md): Updates an existing Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Update task assignee](https://developer.kodexa.ai/api-reference/tasks/put-tasks-id-assignee.md): Assigns a user to the specified task.
- [Update task status](https://developer.kodexa.ai/api-reference/tasks/put-tasks-id-status.md): Updates the status of the specified task.
- [Update task team](https://developer.kodexa.ai/api-reference/tasks/put-tasks-id-team.md): Assigns a team to the specified task.
- [Unlock task](https://developer.kodexa.ai/api-reference/tasks/unlock-task.md): Unlocks a task to allow editing and deletion. Also unlocks all associated document families.
- [Update Task](https://developer.kodexa.ai/api-reference/tasks/update-task.md): Updates an existing Task. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
- [Update task assignee](https://developer.kodexa.ai/api-reference/tasks/update-task-assignee.md): Assigns a user to the specified task.
- [Update task status](https://developer.kodexa.ai/api-reference/tasks/update-task-status.md): Updates the status of the specified task.
- [Update task team](https://developer.kodexa.ai/api-reference/tasks/update-task-team.md): Assigns a team to the specified task.
- [Create TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/create-tasktemplate.md): Creates a new TaskTemplate. Task templates define reusable task configurations with default values.
- [Delete TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/delete-task-templates-id.md): Permanently deletes the specified TaskTemplate. Task templates define reusable task configurations with default values.
- [Delete TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/delete-tasktemplate.md): Permanently deletes the specified TaskTemplate. Task templates define reusable task configurations with default values.
- [List TaskTemplates](https://developer.kodexa.ai/api-reference/tasktemplates/get-task-templates.md): Returns a paginated list of TaskTemplates. Task templates define reusable task configurations with default values.
- [Get TaskTemplate by ID](https://developer.kodexa.ai/api-reference/tasktemplates/get-task-templates-id.md): Retrieves a single TaskTemplate by its unique identifier. Task templates define reusable task configurations with default values.
- [Get TaskTemplate change sequence](https://developer.kodexa.ai/api-reference/tasktemplates/get-task-templates-id-sequence.md): Returns the current change sequence number for the specified TaskTemplate. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TaskTemplate by ID](https://developer.kodexa.ai/api-reference/tasktemplates/get-tasktemplate-by-id.md): Retrieves a single TaskTemplate by its unique identifier. Task templates define reusable task configurations with default values.
- [Get TaskTemplate change sequence](https://developer.kodexa.ai/api-reference/tasktemplates/get-tasktemplate-change-sequence.md): Returns the current change sequence number for the specified TaskTemplate. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List TaskTemplates](https://developer.kodexa.ai/api-reference/tasktemplates/list-tasktemplates.md): Returns a paginated list of TaskTemplates. Task templates define reusable task configurations with default values.
- [Create TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/post-task-templates.md): Creates a new TaskTemplate. Task templates define reusable task configurations with default values.
- [Update TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/put-task-templates-id.md): Updates an existing TaskTemplate. Task templates define reusable task configurations with default values.
- [Update TaskTemplate](https://developer.kodexa.ai/api-reference/tasktemplates/update-tasktemplate.md): Updates an existing TaskTemplate. Task templates define reusable task configurations with default values.
- [Create TeamMember](https://developer.kodexa.ai/api-reference/team-members/create-teammember.md): Creates a new TeamMember. Team members represent users assigned to teams.
- [Delete TeamMember](https://developer.kodexa.ai/api-reference/team-members/delete-team-members-id.md): Permanently deletes the specified TeamMember. Team members represent users assigned to teams.
- [Delete TeamMember](https://developer.kodexa.ai/api-reference/team-members/delete-teammember.md): Permanently deletes the specified TeamMember. Team members represent users assigned to teams.
- [List Team Members](https://developer.kodexa.ai/api-reference/team-members/get-team-members.md): Returns a paginated list of Team Members. Team members represent users assigned to teams.
- [Get TeamMember by ID](https://developer.kodexa.ai/api-reference/team-members/get-team-members-id.md): Retrieves a single TeamMember by its unique identifier. Team members represent users assigned to teams.
- [Get TeamMember change sequence](https://developer.kodexa.ai/api-reference/team-members/get-team-members-id-sequence.md): Returns the current change sequence number for the specified TeamMember. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TeamMember by ID](https://developer.kodexa.ai/api-reference/team-members/get-teammember-by-id.md): Retrieves a single TeamMember by its unique identifier. Team members represent users assigned to teams.
- [Get TeamMember change sequence](https://developer.kodexa.ai/api-reference/team-members/get-teammember-change-sequence.md): Returns the current change sequence number for the specified TeamMember. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Team Members](https://developer.kodexa.ai/api-reference/team-members/list-team-members.md): Returns a paginated list of Team Members. Team members represent users assigned to teams.
- [Create TeamMember](https://developer.kodexa.ai/api-reference/team-members/post-team-members.md): Creates a new TeamMember. Team members represent users assigned to teams.
- [Update TeamMember](https://developer.kodexa.ai/api-reference/team-members/put-team-members-id.md): Updates an existing TeamMember. Team members represent users assigned to teams.
- [Update TeamMember](https://developer.kodexa.ai/api-reference/team-members/update-teammember.md): Updates an existing TeamMember. Team members represent users assigned to teams.
- [Create TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/create-teamorgassignment.md): Creates a new TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [Delete TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/delete-team-org-assignments-id.md): Permanently deletes the specified TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [Delete TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/delete-teamorgassignment.md): Permanently deletes the specified TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [List Team Org Assignments](https://developer.kodexa.ai/api-reference/team-org-assignments/get-team-org-assignments.md): Returns a paginated list of Team Org Assignments. Team org assignments grant a team a role within an organization.
- [Get TeamOrgAssignment by ID](https://developer.kodexa.ai/api-reference/team-org-assignments/get-team-org-assignments-id.md): Retrieves a single TeamOrgAssignment by its unique identifier. Team org assignments grant a team a role within an organization.
- [Get TeamOrgAssignment change sequence](https://developer.kodexa.ai/api-reference/team-org-assignments/get-team-org-assignments-id-sequence.md): Returns the current change sequence number for the specified TeamOrgAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TeamOrgAssignment by ID](https://developer.kodexa.ai/api-reference/team-org-assignments/get-teamorgassignment-by-id.md): Retrieves a single TeamOrgAssignment by its unique identifier. Team org assignments grant a team a role within an organization.
- [Get TeamOrgAssignment change sequence](https://developer.kodexa.ai/api-reference/team-org-assignments/get-teamorgassignment-change-sequence.md): Returns the current change sequence number for the specified TeamOrgAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Team Org Assignments](https://developer.kodexa.ai/api-reference/team-org-assignments/list-team-org-assignments.md): Returns a paginated list of Team Org Assignments. Team org assignments grant a team a role within an organization.
- [Create TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/post-team-org-assignments.md): Creates a new TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [Update TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/put-team-org-assignments-id.md): Updates an existing TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [Update TeamOrgAssignment](https://developer.kodexa.ai/api-reference/team-org-assignments/update-teamorgassignment.md): Updates an existing TeamOrgAssignment. Team org assignments grant a team a role within an organization.
- [Create TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/create-teamprojectassignment.md): Creates a new TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [Delete TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/delete-team-project-assignments-id.md): Permanently deletes the specified TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [Delete TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/delete-teamprojectassignment.md): Permanently deletes the specified TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [List Team Project Assignments](https://developer.kodexa.ai/api-reference/team-project-assignments/get-team-project-assignments.md): Returns a paginated list of Team Project Assignments. Team project assignments grant a team a role within a project.
- [Get TeamProjectAssignment by ID](https://developer.kodexa.ai/api-reference/team-project-assignments/get-team-project-assignments-id.md): Retrieves a single TeamProjectAssignment by its unique identifier. Team project assignments grant a team a role within a project.
- [Get TeamProjectAssignment change sequence](https://developer.kodexa.ai/api-reference/team-project-assignments/get-team-project-assignments-id-sequence.md): Returns the current change sequence number for the specified TeamProjectAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get TeamProjectAssignment by ID](https://developer.kodexa.ai/api-reference/team-project-assignments/get-teamprojectassignment-by-id.md): Retrieves a single TeamProjectAssignment by its unique identifier. Team project assignments grant a team a role within a project.
- [Get TeamProjectAssignment change sequence](https://developer.kodexa.ai/api-reference/team-project-assignments/get-teamprojectassignment-change-sequence.md): Returns the current change sequence number for the specified TeamProjectAssignment. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Team Project Assignments](https://developer.kodexa.ai/api-reference/team-project-assignments/list-team-project-assignments.md): Returns a paginated list of Team Project Assignments. Team project assignments grant a team a role within a project.
- [Create TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/post-team-project-assignments.md): Creates a new TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [Update TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/put-team-project-assignments-id.md): Updates an existing TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [Update TeamProjectAssignment](https://developer.kodexa.ai/api-reference/team-project-assignments/update-teamprojectassignment.md): Updates an existing TeamProjectAssignment. Team project assignments grant a team a role within a project.
- [Create Team](https://developer.kodexa.ai/api-reference/teams/create-team.md): Creates a new Team. Teams group users for collaborative access control within projects.
- [Delete Team](https://developer.kodexa.ai/api-reference/teams/delete-team.md): Permanently deletes the specified Team. Teams group users for collaborative access control within projects.
- [Delete Team](https://developer.kodexa.ai/api-reference/teams/delete-teams-id.md): Permanently deletes the specified Team. Teams group users for collaborative access control within projects.
- [Get Team by ID](https://developer.kodexa.ai/api-reference/teams/get-team-by-id.md): Retrieves a single Team by its unique identifier. Teams group users for collaborative access control within projects.
- [Get Team change sequence](https://developer.kodexa.ai/api-reference/teams/get-team-change-sequence.md): Returns the current change sequence number for the specified Team. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Teams](https://developer.kodexa.ai/api-reference/teams/get-teams.md): Returns a paginated list of Teams. Teams group users for collaborative access control within projects.
- [Get Team by ID](https://developer.kodexa.ai/api-reference/teams/get-teams-id.md): Retrieves a single Team by its unique identifier. Teams group users for collaborative access control within projects.
- [Get Team change sequence](https://developer.kodexa.ai/api-reference/teams/get-teams-id-sequence.md): Returns the current change sequence number for the specified Team. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Invite a user to a team](https://developer.kodexa.ai/api-reference/teams/invite-a-user-to-a-team.md): Adds the given user to the team. If no user exists with the supplied email, a stub user is created so the invitation can complete later.
- [List Teams](https://developer.kodexa.ai/api-reference/teams/list-teams.md): Returns a paginated list of Teams. Teams group users for collaborative access control within projects.
- [Create Team](https://developer.kodexa.ai/api-reference/teams/post-teams.md): Creates a new Team. Teams group users for collaborative access control within projects.
- [Invite a user to a team](https://developer.kodexa.ai/api-reference/teams/post-teams-id-invite.md): Adds the given user to the team. If no user exists with the supplied email, a stub user is created so the invitation can complete later.
- [Update Team](https://developer.kodexa.ai/api-reference/teams/put-teams-id.md): Updates an existing Team. Teams group users for collaborative access control within projects.
- [Update Team](https://developer.kodexa.ai/api-reference/teams/update-team.md): Updates an existing Team. Teams group users for collaborative access control within projects.
- [Create Trigger](https://developer.kodexa.ai/api-reference/triggers/create-trigger.md): Creates a new Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Delete Trigger](https://developer.kodexa.ai/api-reference/triggers/delete-trigger.md): Permanently deletes the specified Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Delete Trigger](https://developer.kodexa.ai/api-reference/triggers/delete-triggers-id.md): Permanently deletes the specified Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Disable a trigger](https://developer.kodexa.ai/api-reference/triggers/disable-a-trigger.md)
- [Enable a trigger](https://developer.kodexa.ai/api-reference/triggers/enable-a-trigger.md)
- [Get Trigger by ID](https://developer.kodexa.ai/api-reference/triggers/get-trigger-by-id.md): Retrieves a single Trigger by its unique identifier. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Get Trigger change sequence](https://developer.kodexa.ai/api-reference/triggers/get-trigger-change-sequence.md): Returns the current change sequence number for the specified Trigger. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Triggers](https://developer.kodexa.ai/api-reference/triggers/get-triggers.md): Returns a paginated list of Triggers. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Get Trigger by ID](https://developer.kodexa.ai/api-reference/triggers/get-triggers-id.md): Retrieves a single Trigger by its unique identifier. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Get Trigger change sequence](https://developer.kodexa.ai/api-reference/triggers/get-triggers-id-sequence.md): Returns the current change sequence number for the specified Trigger. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Triggers](https://developer.kodexa.ai/api-reference/triggers/list-triggers.md): Returns a paginated list of Triggers. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Create Trigger](https://developer.kodexa.ai/api-reference/triggers/post-triggers.md): Creates a new Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Disable a trigger](https://developer.kodexa.ai/api-reference/triggers/post-triggers-id-disable.md): Disables an existing trigger by ID so it stops firing on its schedule or event source, while preserving its configuration for later re-enabling.
- [Enable a trigger](https://developer.kodexa.ai/api-reference/triggers/post-triggers-id-enable.md): Re-enables a previously disabled trigger by ID so it resumes firing on its schedule or event source within the Kodexa platform automation engine.
- [Update Trigger](https://developer.kodexa.ai/api-reference/triggers/put-triggers-id.md): Updates an existing Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Update Trigger](https://developer.kodexa.ai/api-reference/triggers/update-trigger.md): Updates an existing Trigger. Triggers are project-scoped automation rules that start an ActivityPlan when a matching event fires.
- [Create PlatformUser](https://developer.kodexa.ai/api-reference/users/create-platformuser.md): Creates a new PlatformUser. Platform users represent user accounts in Kodexa.
- [Delete PlatformUser](https://developer.kodexa.ai/api-reference/users/delete-platformuser.md): Permanently deletes the specified PlatformUser. Platform users represent user accounts in Kodexa.
- [Delete PlatformUser](https://developer.kodexa.ai/api-reference/users/delete-users-id.md): Permanently deletes the specified PlatformUser. Platform users represent user accounts in Kodexa.
- [Get PlatformUser by ID](https://developer.kodexa.ai/api-reference/users/get-platformuser-by-id.md): Retrieves a single PlatformUser by its unique identifier. Platform users represent user accounts in Kodexa.
- [Get PlatformUser change sequence](https://developer.kodexa.ai/api-reference/users/get-platformuser-change-sequence.md): Returns the current change sequence number for the specified PlatformUser. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get user organization access](https://developer.kodexa.ai/api-reference/users/get-user-organization-access.md): Returns all team-based organization access for the specified user.
- [List Users](https://developer.kodexa.ai/api-reference/users/get-users.md): Returns a paginated list of Users. Platform users represent user accounts in Kodexa.
- [Get PlatformUser by ID](https://developer.kodexa.ai/api-reference/users/get-users-id.md): Retrieves a single PlatformUser by its unique identifier. Platform users represent user accounts in Kodexa.
- [Get PlatformUser change sequence](https://developer.kodexa.ai/api-reference/users/get-users-id-sequence.md): Returns the current change sequence number for the specified PlatformUser. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [Get user organization access](https://developer.kodexa.ai/api-reference/users/get-users-id-teams.md): Returns all team-based organization access for the specified user.
- [List Users](https://developer.kodexa.ai/api-reference/users/list-users.md): Returns a paginated list of Users. Platform users represent user accounts in Kodexa.
- [Create PlatformUser](https://developer.kodexa.ai/api-reference/users/post-users.md): Creates a new PlatformUser. Platform users represent user accounts in Kodexa.
- [Update PlatformUser](https://developer.kodexa.ai/api-reference/users/put-users-id.md): Updates an existing PlatformUser. Platform users represent user accounts in Kodexa.
- [Update PlatformUser](https://developer.kodexa.ai/api-reference/users/update-platformuser.md): Updates an existing PlatformUser. Platform users represent user accounts in Kodexa.
- [Create Workspace](https://developer.kodexa.ai/api-reference/workspaces/create-workspace.md): Creates a new Workspace. Workspaces organize project resources and provide a working context.
- [Delete Workspace](https://developer.kodexa.ai/api-reference/workspaces/delete-workspace.md): Permanently deletes the specified Workspace. Workspaces organize project resources and provide a working context.
- [Delete Workspace](https://developer.kodexa.ai/api-reference/workspaces/delete-workspaces-id.md): Permanently deletes the specified Workspace. Workspaces organize project resources and provide a working context.
- [Get Workspace by ID](https://developer.kodexa.ai/api-reference/workspaces/get-workspace-by-id.md): Retrieves a single Workspace by its unique identifier. Workspaces organize project resources and provide a working context.
- [Get Workspace change sequence](https://developer.kodexa.ai/api-reference/workspaces/get-workspace-change-sequence.md): Returns the current change sequence number for the specified Workspace. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Workspaces](https://developer.kodexa.ai/api-reference/workspaces/get-workspaces.md): Returns a paginated list of Workspaces. Workspaces organize project resources and provide a working context.
- [Get Workspace by ID](https://developer.kodexa.ai/api-reference/workspaces/get-workspaces-id.md): Retrieves a single Workspace by its unique identifier. Workspaces organize project resources and provide a working context.
- [Get Workspace change sequence](https://developer.kodexa.ai/api-reference/workspaces/get-workspaces-id-sequence.md): Returns the current change sequence number for the specified Workspace. Use this for optimistic concurrency control — compare against the changeSequence field before updating.
- [List Workspaces](https://developer.kodexa.ai/api-reference/workspaces/list-workspaces.md): Returns a paginated list of Workspaces. Workspaces organize project resources and provide a working context.
- [Create Workspace](https://developer.kodexa.ai/api-reference/workspaces/post-workspaces.md): Creates a new Workspace. Workspaces organize project resources and provide a working context.
- [Update Workspace](https://developer.kodexa.ai/api-reference/workspaces/put-workspaces-id.md): Updates an existing Workspace. Workspaces organize project resources and provide a working context.
- [Update Workspace](https://developer.kodexa.ai/api-reference/workspaces/update-workspace.md): Updates an existing Workspace. Workspaces organize project resources and provide a working context.
- [Change Log](https://developer.kodexa.ai/change-log/index.md): Release notes and platform updates for the Kodexa AI Platform, including new features, breaking changes, fixes, and migration guidance for each release.
- [Activity](https://developer.kodexa.ai/concepts/activities.md): An Activity is how Kodexa represents a real business process in motion: automated work, human judgment points, state, results, and audit.
- [Adding Validation Rules](https://developer.kodexa.ai/concepts/adding_validation_rules.md): Apply different validation rules based on document characteristics in Kodexa, conditionally adding fields and approval requirements to extractions.
- [Components and Structure](https://developer.kodexa.ai/concepts/components_and_structure.md): How Kodexa components are owned by organizations and shared across the platform, including resource types, URI schemes, and the resolver API.
- [Customizing Extraction by Document Type](https://developer.kodexa.ai/concepts/customizing_extraction.md): Customize document extraction in Kodexa by routing different document types through different prompts, models, and processing rules at runtime.
- [Data Stores](https://developer.kodexa.ai/concepts/data_stores.md): Data Stores hold structured data extracted from labeled documents in Kodexa, linking Data Definitions, attributes, and lineage back to source document stores.
- [Document-Based Validation](https://developer.kodexa.ai/concepts/document-based_validation.md): Add dynamic validation rules to Kodexa documents based on content analysis, ensuring decisions made during processing surface in human-in-the-loop review.
- [Document Stores](https://developer.kodexa.ai/concepts/document_stores.md): Document Stores in Kodexa hold original files and their derived documents in document families, supporting both training and operational workflows.
- [Document Tagging](https://developer.kodexa.ai/concepts/document_tagging.md): Tag content in Kodexa documents at the node or text level, attaching metadata and relationships to power extraction, validation, and review workflows.
- [Documents](https://developer.kodexa.ai/concepts/documents.md): The Kodexa Document Model represents content, metadata, and features in the SQLite-based KDDB format used across the Kodexa Platform and SDKs.
- [Event Handling with Modules](https://developer.kodexa.ai/concepts/event_handling_with_modules.md): Build event-handler modules in Kodexa that react to platform events such as uploads, transitions, and document changes alongside training and inference.
- [Kodexa Concepts Introduction](https://developer.kodexa.ai/concepts/introduction.md): Core Kodexa concepts for modeling document-heavy business processes with Activities, Tasks, documents, knowledge, and human-in-the-loop review.
- [Knowledge and Agents](https://developer.kodexa.ai/concepts/knowledge_and_agents.md): How Kodexa agents build and consume knowledge with human-in-the-loop approval, capturing institutional knowledge as agents work with documents.
- [Knowledge Feature Types Concept](https://developer.kodexa.ai/concepts/knowledge_feature_types.md): Knowledge Feature Types define reusable categories of metadata you capture from documents, providing the vocabulary for cross-document knowledge in Kodexa.
- [Knowledge Item Types](https://developer.kodexa.ai/concepts/knowledge_item_types.md): Knowledge Item Types in Kodexa define configurable capabilities and behaviors for document processing, customizing extraction, prompts, and workflows.
- [Knowledge System](https://developer.kodexa.ai/concepts/knowledge_system.md): The Kodexa Knowledge System captures document metadata and configures intelligent processing behaviors, connecting what you know to what you do.
- [Module Runtimes](https://developer.kodexa.ai/concepts/module_runtimes.md): Module Runtimes provide the execution environment for Kodexa modules, packaging Linux and Python dependencies for Lambda and Kubernetes-based execution.
- [Module Sidecars](https://developer.kodexa.ai/concepts/module_sidecars.md): Module sidecars in Kodexa let modules share code by referencing other modules in module.yml so the runtime downloads them alongside your module.
- [Module Skills](https://developer.kodexa.ai/concepts/module_skills.md): Skill modules in Kodexa package prompts, configurations, and knowledge that agents discover and use, without containing executable code themselves.
- [Modules](https://developer.kodexa.ai/concepts/modules.md): Modules are the core processing units in Kodexa, providing pluggable parsing, transformation, labeling, and inference for documents in projects.
- [Organizations](https://developer.kodexa.ai/concepts/organizations.md): Organizations in Kodexa are logical containers for users, resources, and settings, enabling team collaboration, access control, and workflow management.
- [Project Template Structure Reference](https://developer.kodexa.ai/concepts/project_template_structure.md): Reference for activity-first Kodexa project template structure: stores, data definitions, task templates, forms, statuses, and workspace config.
- [Project Templates Concept](https://developer.kodexa.ai/concepts/project_templates.md): Project templates define reusable Kodexa project blueprints with stores, data definitions, Activity Plan bindings, forms, tasks, and workspace setup.
- [Projects](https://developer.kodexa.ai/concepts/projects.md): Projects in Kodexa bind document stores, data definitions, Activity Plans, Tasks, forms, knowledge, and permissions into one business-process workspace.
- [Security Model](https://developer.kodexa.ai/concepts/security_model.md): The Kodexa Fine-Grained Access Control (FGAC) system uses teams, roles, and permissions to govern access at organization and project levels.
- [Storage](https://developer.kodexa.ai/concepts/storage.md): Kodexa storage uses two store types: Document Stores for files and their KDDB representations, and Data Stores for structured data extracted from them.
- [Tasks](https://developer.kodexa.ai/concepts/tasks.md): Tasks in Kodexa represent human-in-the-loop review steps inside Activities for verifying extracted data, resolving exceptions, and approvals.
- [Working with a Document](https://developer.kodexa.ai/concepts/working_with_a_document.md): Create, save, load, and manipulate Kodexa Documents using the Document SDK in Python and TypeScript, with examples for each common operation.
- [Working with Exceptions](https://developer.kodexa.ai/concepts/working_with_exceptions.md): Use the Kodexa ContentException class to flag, track, and resolve issues found during document processing, with severity, type, and metadata fields.
- [Working with Modules](https://developer.kodexa.ai/concepts/working_with_modules.md): Build, deploy, and manage Kodexa modules using Python and the Kodexa SDK to extract data from documents and integrate processing into projects.
- [Working with Projects](https://developer.kodexa.ai/concepts/working_with_projects.md): Use the Project class in the Kodexa Python SDK to create, query, and manage projects programmatically, including resources, assistants, and metadata.
- [KDX CLI Quick Start](https://developer.kodexa.ai/essentials/kodexa-cli.md): Quick start guide for the KDX CLI, the kubectl-style command-line interface for managing the Kodexa AI Platform from your terminal.
- [Agent Steps](https://developer.kodexa.ai/guides/activity-plans/agent-steps.md): Use AGENT steps in Activity Plans to delegate bounded work to a Kodexa agent runtime when workflows require tool use or multi-step reasoning.
- [AI Naming](https://developer.kodexa.ai/guides/activity-plans/ai-naming.md): Use an LLM to automatically generate contextual titles and descriptions for activities, tasks, and intake documents to keep dashboards readable.
- [Approval Steps](https://developer.kodexa.ai/guides/activity-plans/approval-steps.md): Model explicit approval gates in Activity Plans with APPROVAL steps that pause processing until an authorized person or role approves the next move.
- [Create Task Steps](https://developer.kodexa.ai/guides/activity-plans/create-task-steps.md): Use CREATE_TASK steps in Activity Plans to bring people into the workflow for review, correction, approval, exception handling, or escalation.
- [Execution Steps](https://developer.kodexa.ai/guides/activity-plans/execution-steps.md): Run modules and automated processing as EXECUTION steps in Activity Plans, covering extraction, classification, conversion, enrichment, and validation.
- [Activity Plans](https://developer.kodexa.ai/guides/activity-plans/index.md): Activity Plans define reusable automated workflows in Kodexa, with each Activity representing one run of the plan inside a project for document processing.
- [LLM Steps](https://developer.kodexa.ai/guides/activity-plans/llm-steps.md): Use LLM steps in Activity Plans to run bounded prompts, map model output, and make AI reasoning explicit, observable, and connected to the workflow graph.
- [Script Steps in Activity Plans](https://developer.kodexa.ai/guides/activity-plans/script-steps.md): Use SCRIPT steps in Activity Plans to run JavaScript for routing, enrichment, and document logic that is too specific for declarative steps.
- [Service Bridge Steps in Activity Plans](https://developer.kodexa.ai/guides/activity-plans/service-bridge-steps.md): Use BRIDGE_CALL steps in Activity Plans to call external systems through service bridges with first-class status, retries, logs, and audit trails.
- [Activity Plan Steps](https://developer.kodexa.ai/guides/activity-plans/steps.md): Reference for all step kinds in a Kodexa Activity Plan, including how steps materialize at runtime and how status, timing, results, and logs are tracked.
- [Author Metadata with Claude Code](https://developer.kodexa.ai/guides/claude-code/authoring-metadata.md): Use Claude Code with the Kodexa Metadata Skills plugin to author, edit, review, and migrate Kodexa platform configuration files in a Git-backed repository.
- [Working with Claude Code](https://developer.kodexa.ai/guides/claude-code/index.md): Use Claude Code with Kodexa metadata skills to author configuration on disk, review it in Git, and sync it into Kodexa with the KDX CLI.
- [Install the Kodexa Skills](https://developer.kodexa.ai/guides/claude-code/installing-skills.md): Install the Kodexa Metadata Skills plugin in Claude Code and learn how to invoke the correct authoring skill for each Kodexa platform resource type.
- [Sync Claude Code Changes with KDX](https://developer.kodexa.ai/guides/claude-code/syncing-with-kdx.md): Validate, dry-run, push, and deploy Claude Code-authored Kodexa metadata to dev, staging, and production environments using the KDX CLI sync workflow.
- [Building Data Classes](https://developer.kodexa.ai/guides/data-definitions/building-data-classes.md): Build Python data classes from Kodexa Data Definitions to apply business rules, validation, and transformations to extracted document data programmatically.
- [Data Types](https://developer.kodexa.ai/guides/data-definitions/data-types.md): Reference for data types used by Data Definitions, including how data elements, data stores, and extraction workflows combine to produce structured output.
- [Event-Based Scripting](https://developer.kodexa.ai/guides/data-definitions/event-subscriptions.md): Attach reactive JavaScript to Kodexa data definitions so data changes derive values, call service bridges, manage exceptions, and update related fields.
- [Contract Data Definition Example](https://developer.kodexa.ai/guides/data-definitions/examples/contract.md): Complete example data definition for extracting contract metadata, parties, financial terms, dates, obligations, and legal clauses from legal documents.
- [Form Data Definition Example](https://developer.kodexa.ai/guides/data-definitions/examples/form.md): Example Kodexa data definition for processing structured forms, applications, surveys, and questionnaires with diverse field types and conditional logic.
- [Invoice Data Definition Example](https://developer.kodexa.ai/guides/data-definitions/examples/invoice.md): Production-ready example data definition for invoice extraction in Kodexa, covering header fields, vendor details, line items, totals, and validations.
- [Purchase Order Data Definition Example](https://developer.kodexa.ai/guides/data-definitions/examples/purchase-order.md): Example Kodexa data definition for extracting purchase orders, including buyer details, line items, shipping, pricing, and approval workflows.
- [Data Definitions Guide](https://developer.kodexa.ai/guides/data-definitions/index.md): Define the structure, validation rules, and extraction logic for document data in Kodexa using Data Definitions and configurable data elements.
- [Selection Option Formulas](https://developer.kodexa.ai/guides/data-definitions/selection-option-formulas.md): Compute dropdown options for SELECTION data elements dynamically using JavaScript formulas that evaluate per data object and react to attribute changes.
- [Data Definition Concepts](https://developer.kodexa.ai/guides/data-definitions/taxonomy-concepts.md): Understand Data Definitions in Kodexa and how they model the structured data, groups, validation rules, and extraction targets for document-heavy workflows.
- [Data Definition Structure](https://developer.kodexa.ai/guides/data-definitions/taxonomy-guide.md): Define and configure Kodexa Data Definitions for document extraction, including data elements, types, validation, formatting, and extraction logic.
- [Validation and Conditional Formatting](https://developer.kodexa.ai/guides/data-definitions/validation-and-conditional-formatting.md): Define validation rules and conditional formatting on Data Definition elements, using Kodexa formulas to evaluate business rules against document data.
- [Bridge API & External Services](https://developer.kodexa.ai/guides/data-forms/bridge-api.md): Use the Bridge API in Kodexa data forms for platform data access, HTTP requests, and service bridge integration directly from sandboxed scripts.
- [Data Binding & Context](https://developer.kodexa.ai/guides/data-forms/data-binding.md): Bind data form components to extracted document data in Kodexa using context variables, expressions, and scoped data for multi-instance documents.
- [Data Components](https://developer.kodexa.ai/guides/data-forms/data-components.md): Reference for Kodexa data form components: attribute editors, labels, tables, grids, markdown, exceptions, and knowledge sections bound to taxonomies.
- [Extracting Data from Documents](https://developer.kodexa.ai/guides/data-forms/extraction.md): Extract values into Kodexa data forms with direct extract for verbatim text or AI extraction for LLM-powered field population from the document viewer.
- [Data Forms Guide](https://developer.kodexa.ai/guides/data-forms/index.md): Build schema-driven UIs in Kodexa for document data review and correction, combining layout components, data components, scripting, and extraction tools.
- [Data Forms Introduction](https://developer.kodexa.ai/guides/data-forms/introduction.md): Data Forms are schema-driven UI definitions in Kodexa that control how extracted data is presented for human review alongside the spatial document viewer.
- [Layout Components](https://developer.kodexa.ai/guides/data-forms/layout-components.md): Reference for Kodexa data form layout components: panels, tabs, rows, columns, dividers, and alerts for structuring form layouts and visual hierarchy.
- [Form Structure & Schema](https://developer.kodexa.ai/guides/data-forms/schema-structure.md): Reference for the Kodexa data form schema, covering UINode tree structure, conditional rendering, iteration, and the top-level form shape.
- [Events & Scripting](https://developer.kodexa.ai/guides/data-forms/scripting.md): Add dynamic behavior to Kodexa data forms with event handlers, the QuickJS runtime, the document API, and reactive triggers that respond to data changes.
- [Formulas Guide](https://developer.kodexa.ai/guides/formulas/index.md): Write Kodexa formulas for calculations, string manipulation, dates, and logical decisions, referencing taxonomy attributes and conditionally formatting data.
- [Intakes](https://developer.kodexa.ai/guides/intakes/index.md): Intakes are public upload endpoints that route documents from external systems into Kodexa document stores with metadata and automation.
- [Large File Uploads](https://developer.kodexa.ai/guides/intakes/large-uploads.md): Upload files over 256 MB to Kodexa intakes using presigned S3 URLs for single-file uploads or multipart uploads for resumable, chunked transfers.
- [Intake Scripting](https://developer.kodexa.ai/guides/intakes/scripting.md): Write sandboxed JavaScript intake scripts in Kodexa to validate uploads, enrich metadata, reject invalid files, and route documents to Activity Plans.
- [Guides](https://developer.kodexa.ai/guides/introduction.md): Guides for modeling, building, and operating document workflows in Kodexa, covering data definitions, Activity Plans, modules, and deployment.
- [Authentication](https://developer.kodexa.ai/guides/kdx-cli/authentication.md): Configure authentication for the kdx CLI in Kodexa using access tokens, profiles, or environment variables to connect to Kodexa environments.
- [Command Reference](https://developer.kodexa.ai/guides/kdx-cli/command-reference.md): Complete reference for kdx CLI commands, global flags, authentication, profiles, sync, document, knowledge, and secret operations on the Kodexa Platform.
- [Document Family Commands](https://developer.kodexa.ai/guides/kdx-cli/document-family-commands.md): Use the kdx document-family CLI to export extracted data, list and download content objects, and manage document-family labels and statuses.
- [Agentic CLI Use](https://developer.kodexa.ai/guides/kdx-cli/document/agentic-use.md): How AI agents like Claude Code use kdx document commands to programmatically analyze, search, annotate, and extract structured data from KDDB files.
- [Audit](https://developer.kodexa.ai/guides/kdx-cli/document/audit.md): Use kdx document audit to view the audit trail and revision history for data objects, attributes, and exceptions inside a local KDDB document.
- [Data Objects and Attributes](https://developer.kodexa.ai/guides/kdx-cli/document/data.md): Inspect and create data objects, attributes, and exceptions in KDDB documents from the kdx CLI, working with the structured data layer of a document.
- [Delta](https://developer.kodexa.ai/guides/kdx-cli/document/delta.md): Use kdx document delta to decode and inspect Kodexa delta binary files, viewing the operations they contain without applying them to a document.
- [External Data with kdx CLI](https://developer.kodexa.ai/guides/kdx-cli/document/external-data.md): Manage key-value external data stored in KDDB documents from the kdx CLI for custom data, processing results, or extension-specific information.
- [Find Nodes by Combined Criteria](https://developer.kodexa.ai/guides/kdx-cli/document/find.md): Use kdx document find to search KDDB documents with combined criteria across content, node type, page, tags, and spatial regions using AND logic.
- [Document Summary Info](https://developer.kodexa.ai/guides/kdx-cli/document/info.md): Use kdx document info to display a summary of a KDDB document including UUID, version, source metadata, labels, statistics, and custom fields.
- [Locate](https://developer.kodexa.ai/guides/kdx-cli/document/locate.md): Use kdx document locate to find nodes with character match positions, designed for agent workflows that need precise tagging and data linking.
- [Document Metadata with kdx CLI](https://developer.kodexa.ai/guides/kdx-cli/document/metadata.md): View and modify document metadata in KDDB files from the kdx CLI, including UUID, version, source information, labels, and custom properties.
- [Native Files](https://developer.kodexa.ai/guides/kdx-cli/document/native-files.md): List and extract embedded native files such as PDFs, images, and Word documents from a KDDB document using kdx document natives commands.
- [Inspect a Content Node](https://developer.kodexa.ai/guides/kdx-cli/document/node.md): Use kdx document node to inspect a single content node by ID, with optional features, tags, children, and bounding box detail in JSON output.
- [Document Commands](https://developer.kodexa.ai/guides/kdx-cli/document/overview.md): Reference for the kdx document command suite for working offline with local KDDB files: inspecting, searching, annotating, and extracting structured data.
- [Query Commands](https://developer.kodexa.ai/guides/kdx-cli/document/query.md): Use kdx document grep and lines commands for Unix-style text search and line retrieval in KDDB files, with JSON Lines output for shell pipelines.
- [Spatial](https://developer.kodexa.ai/guides/kdx-cli/document/spatial.md): Use spatial commands in the kdx CLI to query KDDB document content by position, finding nodes inside bounding boxes or listing boxes on a page.
- [Stats](https://developer.kodexa.ai/guides/kdx-cli/document/stats.md): Use kdx document stats to display detailed statistics for a KDDB document, including page count, node types, tag distribution, data objects, and exceptions.
- [Document Structure](https://developer.kodexa.ai/guides/kdx-cli/document/structure.md): Use kdx document print and select commands to inspect, navigate, and query the hierarchical structure of KDDB documents from the command line.
- [Tag a Content Node](https://developer.kodexa.ai/guides/kdx-cli/document/tag-cmd.md): Use kdx document tag to add tags to KDDB content nodes for annotation and extraction, with support for values, confidence scores, and tagUuid links.
- [List Document Tags](https://developer.kodexa.ai/guides/kdx-cli/document/tags.md): Use kdx document tags to list every unique tag in a KDDB document along with how many times each tag appears across content nodes.
- [Extract Document Text](https://developer.kodexa.ai/guides/kdx-cli/document/text.md): Use kdx document text to extract readable text from KDDB documents page by page with markers, with options for page range and node-specific extraction.
- [Dynamic API Operations](https://developer.kodexa.ai/guides/kdx-cli/dynamic-api.md): Use kdx run to discover and execute resource-specific Kodexa API operations beyond standard get, describe, apply, and delete commands.
- [Installation](https://developer.kodexa.ai/guides/kdx-cli/installation.md): Install the KDX CLI on macOS, Linux, or Windows using Homebrew, package managers, or direct binary downloads for the Kodexa AI Platform.
- [Knowledge Commands](https://developer.kodexa.ai/guides/kdx-cli/knowledge-commands.md): Use kdx knowledge attach and download commands to upload files, zipped folders, and supporting assets to Kodexa knowledge items, then retrieve them later.
- [KDX CLI: Commands, Sync, and Resource Management](https://developer.kodexa.ai/guides/kdx-cli/overview.md): KDX CLI is the command-line interface for managing Kodexa resources, GitOps metadata, documents, knowledge attachments, secrets, and operational workflows.
- [Profiles & Configuration](https://developer.kodexa.ai/guides/kdx-cli/profiles-configuration.md): Manage KDX CLI profiles, command-line overrides, production safeguards, and sync environment credentials for Kodexa Platform access.
- [Project Commands](https://developer.kodexa.ai/guides/kdx-cli/project-commands.md): Use kdx project commands to create Kodexa projects from project templates and then manage project metadata with resource and sync commands.
- [Quick Start](https://developer.kodexa.ai/guides/kdx-cli/quickstart.md): Get started with the KDX CLI: install, authenticate, discover Kodexa resources, inspect projects, apply metadata, and run GitOps sync workflows.
- [Resource Operations](https://developer.kodexa.ai/guides/kdx-cli/resource-operations.md): Use KDX CLI resource operations to discover, read, validate, apply, delete, and execute Kodexa Platform resources from the terminal.
- [Secret Commands](https://developer.kodexa.ai/guides/kdx-cli/secret-commands.md): Use kdx secret commands to list, create, update, and delete write-only organization secrets used by Activity steps, modules, and service bridge integrations.
- [Store Commands](https://developer.kodexa.ai/guides/kdx-cli/store-commands.md): Use kdx store commands to upload documents, monitor processing, and manage document stores from the command line on the Kodexa AI Platform.
- [CI/CD Integration](https://developer.kodexa.ai/guides/kdx-cli/sync/ci-cd.md): Automate Kodexa metadata deployments using kdx sync deploy in GitHub Actions, GitLab CI, Jenkins, and other CI/CD pipelines for repeatable rollouts.
- [Sync Configuration](https://developer.kodexa.ai/guides/kdx-cli/sync/configuration.md): Configure environments, sync targets, and deployment mappings in sync-config.yaml for GitOps workflows on the Kodexa AI Platform with kdx sync.
- [Conflict Detection](https://developer.kodexa.ai/guides/kdx-cli/sync/conflict-detection.md): How kdx sync detects and handles conflicting changes between local YAML files and server state using sync state files and conflict resolution strategies.
- [Getting Started with Sync](https://developer.kodexa.ai/guides/kdx-cli/sync/getting-started.md): Set up your first GitOps workflow for Kodexa metadata in 10 minutes using kdx sync, sync-config.yaml, and manifest files for repeatable deployments.
- [Manifests & Resource Types](https://developer.kodexa.ai/guides/kdx-cli/sync/manifests.md): Define kdx sync manifest files that group Kodexa resources—Activity Plans, data definitions, forms, modules, projects—for each deployment target.
- [kdx sync: GitOps for Kodexa Metadata and Resources](https://developer.kodexa.ai/guides/kdx-cli/sync/overview.md): Manage Kodexa Activity Plans, data definitions, data forms, modules, project templates, project bindings, and other metadata with kdx sync.
- [Pull, Push & Deploy](https://developer.kodexa.ai/guides/kdx-cli/sync/pull-push.md): Use kdx sync pull, push, discover, and deploy commands to move Kodexa metadata between local YAML files and platform environments across targets.
- [CLI Use Cases](https://developer.kodexa.ai/guides/kdx-cli/use-cases.md): Understand where the kdx CLI fits across Kodexa development, GitOps deployment, Activity Plan promotion, document operations, and day-to-day debugging tasks.
- [Resource Validation](https://developer.kodexa.ai/guides/kdx-cli/validate.md): Validate resource YAML files against the Kodexa API schema with kdx validate, catching typos, missing required fields, and type mismatches before deployment.
- [Content Structures & Mixins](https://developer.kodexa.ai/guides/kodexa-document/content-structures.md): How Kodexa uses mixins and content structures in KDDB to handle spatial documents, markdown, email, and other content types in a unified node tree.
- [What is a Kodexa Document?](https://developer.kodexa.ai/guides/kodexa-document/index.md): Understand the KDDB document format at the heart of the Kodexa Platform, including content nodes, mixins, features, tags, and structured data layers.
- [Document Structure Deep Dive](https://developer.kodexa.ai/guides/kodexa-document/structure.md): Deep dive into Kodexa Document structure: content nodes, spatial data, page mapping, and how the document tree represents real-world documents in KDDB.
- [Build Kodexa Project Templates](https://developer.kodexa.ai/guides/project-templates/building-project-templates.md): Hands-on guide to designing, building, and deploying effective Kodexa project templates that capture configurations, resources, and workflows for reuse.
- [Project Templates Guide](https://developer.kodexa.ai/guides/project-templates/introduction.md): Build, deploy, and use activity-first project templates in Kodexa to create reusable workspaces for document-heavy business processes.
- [Filtering](https://developer.kodexa.ai/guides/reference/filtering-api.md): Reference for filtering Kodexa list API endpoints, including the two filter formats and how to combine criteria when querying platform resources.
- [API Reference & Advanced Topics](https://developer.kodexa.ai/guides/reference/index.md): Technical reference for advanced Kodexa features and APIs, covering filtering, options architecture, advanced patterns, and configuration internals.
- [Advanced Options Features](https://developer.kodexa.ai/guides/reference/options-advanced-features.md): Advanced patterns and expert techniques for Kodexa Options, covering complex configurations and sophisticated user-facing configuration interfaces.
- [Options Architecture](https://developer.kodexa.ai/guides/reference/options-architecture.md): Reference for the Kodexa Options system architecture, including how declarative options enable flexible, type-safe configuration interfaces across components.
- [Working with Options](https://developer.kodexa.ai/guides/reference/working-with-options.md): Complete reference for Kodexa Options, including how to define configuration parameters, capture user input, and build flexible component customization.
- [Scheduled Jobs Guide](https://developer.kodexa.ai/guides/scheduled-jobs/index.md): Create and manage scheduled jobs in the Kodexa Platform that run modules on a recurring cron-like schedule for automated document processing tasks.
- [SCRIPT Step Runtime Reference](https://developer.kodexa.ai/guides/script-steps/index.md): Reference the JavaScript runtime available to SCRIPT steps inside Kodexa Activity Plans, including task, document, bridge, LLM, and logging objects.
- [Scripting Reference](https://developer.kodexa.ai/guides/scripting/index.md): Server-side JavaScript scripting with the GoJA runtime for intake scripts, workflow steps, event subscriptions, and option formulas
- [Calling Service Bridges from Scripts](https://developer.kodexa.ai/guides/scripting/service-bridges.md): Use the serviceBridge API in Kodexa scripts to call external systems through pre-configured API proxies with centralized authentication and policies.
- [Gating actions on exceptions](https://developer.kodexa.ai/guides/task-templates/gating-actions-on-exceptions.md): Configure task template actions to disable approve and accept buttons until open data exceptions on critical taxon paths are resolved by the reviewer.
- [Task template patterns for human-in-the-loop review](https://developer.kodexa.ai/guides/task-templates/index.md): Author reusable task configurations — actions, options, document groups, and the cookbook patterns for safe human-in-the-loop review.
- [Take-ownership pattern](https://developer.kodexa.ai/guides/task-templates/take-ownership-pattern.md): Use the ownerUri provenance flag on accepted attribute values so AI agents, event subscriptions, and automation pipelines stop overwriting reviewer edits.
- [Kodexa Developer Portal](https://developer.kodexa.ai/introduction.md): The Kodexa Developer Portal: documentation, guides, SDKs, and references for building document workflows, modules, and integrations on the Kodexa Platform.
- [Audit Trail](https://developer.kodexa.ai/sdk/audit-trail.md): Track the revision history of data objects, attributes, and tags inside Kodexa documents using the audit trail to see who changed what and when.
- [Content Nodes](https://developer.kodexa.ai/sdk/content-nodes.md): Build and navigate hierarchical document structures in Kodexa using content nodes, which represent text, sections, pages, features, and tags in KDDB.
- [Data Objects & Attributes](https://developer.kodexa.ai/sdk/data-objects.md): Manage structured extracted data inside Kodexa documents using data objects and data attributes, the structured data layer that sits on top of KDDB nodes.
- [Delta Tracking](https://developer.kodexa.ai/sdk/delta-tracking.md): Track, export, preview, and apply Kodexa document changes between versions using delta tracking sessions for collaborative editing and synchronization.
- [External Data in the SDK](https://developer.kodexa.ai/sdk/external-data.md): Store arbitrary JSON data alongside Kodexa documents using the external data key-value store for processing results, cached data, and extension data.
- [Get Started with the Kodexa SDK](https://developer.kodexa.ai/sdk/getting-started.md): Get started with the Kodexa Document SDK: create, load, manipulate, and save Kodexa Documents using essential operations for document processing apps.
- [Kodexa Document SDK](https://developer.kodexa.ai/sdk/index.md): The Kodexa Document SDK is a cross-platform library for building document processing apps with KDDB documents in Python, TypeScript, and other languages.
- [Document Metadata in the SDK](https://developer.kodexa.ai/sdk/metadata.md): Work with document-level metadata and labels in Kodexa, storing properties such as title, author, dates, and processing status separately from node features.
- [Native Documents](https://developer.kodexa.ai/sdk/native-documents.md): Embed and retrieve binary files such as PDFs, images, and Word documents inside KDDB Kodexa Documents using the native documents API of the SDK.
- [Notes](https://developer.kodexa.ai/sdk/notes.md): Add human-readable annotations and comments to Kodexa documents, data objects, and data attributes using notes that support multiple content formats.
- [Extraction](https://developer.kodexa.ai/sdk/python/extraction.md): Use the Kodexa Python SDK extraction subsystem to convert tagged document content into structured data objects and attributes via taxonomy definitions.
- [Get Started with the Python SDK](https://developer.kodexa.ai/sdk/python/getting-started.md): Get started with the Kodexa Document Python SDK: create, load, manipulate, and save KDDB documents with essential operations and Python code examples.
- [Python SDK](https://developer.kodexa.ai/sdk/python/index.md): Install and configure the Kodexa Document Python SDK (kodexa-document) to build document processing apps backed by a high-performance Go core via CFFI.
- [LLM & Model Manager](https://developer.kodexa.ai/sdk/python/llm.md): Call large language models from Kodexa Python modules through the Kodexa AI Gateway, with central credentials, routing, rate limiting, and cost tracking.
- [Platform Client](https://developer.kodexa.ai/sdk/python/platform-client.md): Connect to the Kodexa Platform API from Python using the Platform Client, with typed endpoint classes, pagination, serialization, and authentication.
- [Platform Models](https://developer.kodexa.ai/sdk/python/platform-models.md): Auto-generated Pydantic models for the Kodexa Platform API providing type-safe access to all platform resources from the Python SDK.
- [Processing](https://developer.kodexa.ai/sdk/python/processing.md): Track Kodexa document processing steps, knowledge items, and execution pipelines from Python using the processing module of the Python SDK.
- [Selectors](https://developer.kodexa.ai/sdk/selectors.md): Query Kodexa documents with the selector engine, an XPath-like syntax for finding nodes, filtering by attributes, and navigating document hierarchies.
- [Transactions](https://developer.kodexa.ai/sdk/transactions.md): Use Kodexa transactions to batch data object and attribute operations into atomic units, providing all-or-nothing semantics and high-performance bulk writes.

## OpenAPI Specs

- [api-docs](https://developer.kodexa.ai/api-reference/api-docs.yaml)
- [filtered-api-docs](https://developer.kodexa.ai/api-reference/filtered-api-docs.yaml)

## Optional

- [Kodexa](https://www.kodexa.ai)