Claromentis Integration

Claromentis integrations import knowledge base content. Enable Claromentis at the instance level first—see the operator guide: Claromentis integration setup.

Basic request and response

Create a Claromentis integration with POST /api/v1/app/integration/claromentis.

Endpoint parameters

Type	Name	Required	Notes
Body	`username`	Yes	Claromentis username.
Body	`password`	Yes	Claromentis password.

curl -X POST "https://{BASE_URL}/api/v1/app/integration/claromentis" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "{username}",
    "password": "{password}"
  }'

Example response

{
  "id": "clar_3c2d1b4a5f6e7d8c",
  "user_id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "type": "Claromentis",
  "created_at": "2026-02-08T14:05:00Z",
  "updated_at": "2026-02-08T14:05:00Z"
}

Update integration credentials

Endpoint parameters

Type	Name	Required	Notes
Path	`integrationID`	Yes	Integration identifier.
Body	`username`	Yes	Claromentis username.
Body	`password`	Yes	Claromentis password.

curl -X POST "https://{BASE_URL}/api/v1/app/integration/claromentis/{integrationID}" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "{username}",
    "password": "{password}"
  }'

Example response

{
  "id": "clar_3c2d1b4a5f6e7d8c",
  "user_id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "type": "Claromentis",
  "created_at": "2026-02-08T14:05:00Z",
  "updated_at": "2026-02-08T15:10:00Z"
}

Get integration config

curl "https://{BASE_URL}/api/v1/app/integration/claromentis/{integrationID}/config" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

Example response

{
  "base_url": "https://claromentis.auroralabs.com",
  "site": "Knowledge Base"
}

Start an ingest sync

curl -X POST "https://{BASE_URL}/api/v1/app/integration/claromentis/{integrationID}/ingest" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json"

Example response

{
  "type": "sync_started",
  "current_artifact_count": 6,
  "integration_item_count": 24
}

Errors and edge cases

403: connector not enabled or missing permissions.
404: integration ID not found.

​Basic request and response

​Update integration credentials

​Get integration config

​Start an ingest sync

​Errors and edge cases

Basic request and response

Update integration credentials

Get integration config

Start an ingest sync

Errors and edge cases