Skip to main content
GET
/
api
/
orchestrator-stores
/
{id}
Get OrchestratorStore by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/orchestrator-stores/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "s3Bucket": "<string>",
  "s3Prefix": "<string>",
  "storeType": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<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

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The OrchestratorStore

An orchestrator store manages document storage for pipeline-based processing.

changeSequence
integer<int32>
createdBy
string | null
createdOn
string<date-time>
description
string | null
id
string
metadata
object
name
string
organizationId
string
s3Bucket
string
s3Prefix
string
storeType
string
updatedOn
string<date-time>
uuid
string