Skip to main content
POST
/
api
/
intakes
Create Intake
curl --request POST \
  --url https://platform.kodexa.ai/api/intakes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": true,
  "allowMultipleFiles": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "knowledgeFeatureIds": {},
  "metadata": {},
  "name": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000"
  },
  "organizationId": "<string>",
  "script": "<string>",
  "scriptEnabled": true,
  "slug": "<string>",
  "store": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deprecated": true,
    "eventAware": true,
    "extensionPackRef": "<string>",
    "id": "<string>",
    "metadata": {
      "deleteProtection": true,
      "metadata": {
        "documentProperties": "<unknown>",
        "indexed": true,
        "labelExpressions": "<unknown>",
        "type": "<string>"
      },
      "storePurpose": "<string>",
      "storeType": "<string>"
    },
    "name": "<string>",
    "organizationId": "<string>",
    "publicAccess": true,
    "slug": "<string>",
    "supportsScheduling": true,
    "template": true,
    "type": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "yamlSource": "<string>"
  },
  "taskTemplateId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "active": true,
  "allowMultipleFiles": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "knowledgeFeatureIds": {},
  "metadata": {},
  "name": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000"
  },
  "organizationId": "<string>",
  "script": "<string>",
  "scriptEnabled": true,
  "slug": "<string>",
  "store": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deprecated": true,
    "eventAware": true,
    "extensionPackRef": "<string>",
    "id": "<string>",
    "metadata": {
      "deleteProtection": true,
      "metadata": {
        "documentProperties": "<unknown>",
        "indexed": true,
        "labelExpressions": "<unknown>",
        "type": "<string>"
      },
      "storePurpose": "<string>",
      "storeType": "<string>"
    },
    "name": "<string>",
    "organizationId": "<string>",
    "publicAccess": true,
    "slug": "<string>",
    "supportsScheduling": true,
    "template": true,
    "type": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "yamlSource": "<string>"
  },
  "taskTemplateId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Body

application/json

An intake configures how documents are ingested from external sources.

​
active
boolean
​
allowMultipleFiles
boolean
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
knowledgeFeatureIds
object
​
metadata
object
​
name
string
​
organization
object

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

​
organizationId
string | null
​
script
string | null
​
scriptEnabled
boolean
​
slug
string
​
store
object
​
taskTemplateId
string | null
​
updatedOn
string<date-time>
​
uuid
string

Response

Created Intake

An intake configures how documents are ingested from external sources.

​
active
boolean
​
allowMultipleFiles
boolean
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
knowledgeFeatureIds
object
​
metadata
object
​
name
string
​
organization
object

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

​
organizationId
string | null
​
script
string | null
​
scriptEnabled
boolean
​
slug
string
​
store
object
​
taskTemplateId
string | null
​
updatedOn
string<date-time>
​
uuid
string