Get PlatformConfiguration by ID

curl --request GET \
  --url https://platform.kodexa.ai/api/platform-configurations/{id} \
  --header 'x-api-key: <api-key>'

{
  "aboutMarkdown": "<string>",
  "changeLogArticleId": "<string>",
  "changeSequence": 123,
  "cornerIcon": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "platformDashboardRefs": "<string>",
  "runBackgroundServices": true,
  "settings": {},
  "stylesheet": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "welcomeMarkdown": "<string>"
}

GET

api

platform-configurations

{id}

Get PlatformConfiguration by ID

curl --request GET \
  --url https://platform.kodexa.ai/api/platform-configurations/{id} \
  --header 'x-api-key: <api-key>'

{
  "aboutMarkdown": "<string>",
  "changeLogArticleId": "<string>",
  "changeSequence": 123,
  "cornerIcon": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "platformDashboardRefs": "<string>",
  "runBackgroundServices": true,
  "settings": {},
  "stylesheet": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "welcomeMarkdown": "<string>"
}

Authorizations

x-api-key

string

header

required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

string<uuid>

required

Unique identifier (UUID) of the resource.

Response

The PlatformConfiguration

Platform configuration stores platform-wide settings and feature flags.

aboutMarkdown

string

changeLogArticleId

string

changeSequence

integer<int32>

cornerIcon

string

createdOn

string<date-time>

string

platformDashboardRefs

string

runBackgroundServices

boolean | null

settings

object

stylesheet

string

updatedOn

string<date-time>

uuid

string

welcomeMarkdown

string

Create PlatformConfiguration Update PlatformConfiguration

Introduction

Organizations

Projects

Tasks

Document Families

Document Stores

Taxonomies

Assistants

Data Forms

Data Exceptions

Content Objects

Scheduled Jobs

Extension Packs

Executions

Dashboards

Guidance

Notes

Knowledge

Embeddings & Model Costs

Batch Updates

Account & Users

Platform

AccessTokens

Account

Applied Knowledge Sets

Applied Knowledge

AssistantConnection

Assistants

Batch Updates

Channel

Cloud Models

Platform Overview

Content Exception

Content Object

Credit Transactions

Dashboards

DataAttributes

Data Definitions

Data Forms

DataObjects

Data Stores

Document Assignments

Document External Data

DocumentFamilies

Document Family Statistics

Document Statuses

Document Stores

Document Transitions

Embeddings

Events

Data Exceptions

Executions

Extension Packs

Guidance

Intakes

Job Document Family Interactions

Knowledge Clause Features

Knowledge Clauses

Knowledge Feature Types

Knowledge Features

Knowledge Item Types

Knowledge Items

Knowledge Set Snapshots

Knowledge Set Sources

Knowledge Sets

Labels

Linked Deltas

Memberships

Messages

Model Costs

Module Runtimes

Notes

Orchestrator Agent Runtimes

Orchestrator Agent Sessions

Orchestrator Content Objects

Orchestrator Execution Slices

Orchestrator Module Runtimes

Orchestrator Module Versions

Orchestrator Modules

Orchestrator Pipeline Executions