Create Mongo Collection Sync

POST https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync Content-Type: application/json

Credal lets you easily sync your MongoDB data for use in Collections and Agents. Create a new sync from a MongoDB collection to a Credal collection.

Reference: https://docs.credal.ai/api-reference/api-reference/document-collections/create-mongo-collection-sync

• Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Body (application/json)

This endpoint expects an object.

• collectionId (UUID, required)
• mongoURI (string, required)
• config (MongoCollectionSyncConfig, required)

200

• mongoCredentialId (UUID, required)
• resourceId (string, required)
• syncLaunched (boolean, required)

Types

MongoCollectionSyncConfig

• syncName (string, required)
• collectionName (string, required)
• filterExpression (any, required)
• sourceFields (MongoSourceFieldsConfig, required)

MongoSourceFieldsConfig

• body (string, required)
• sourceName (string, required)
• sourceSystemUpdated (string, optional)
• sourceUrl (string, optional)

Examples

Request

{
  "collectionId": "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
  "mongoURI": "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
  "config": {
    "syncName": "My sales transcripts",
    "collectionName": "myCollection",
    "filterExpression": {
      "status": {
        "$ne": "disabled"
      }
    },
    "sourceFields": {
      "body": "body",
      "sourceName": "meetingName",
      "sourceSystemUpdated": "transcriptDatetime",
      "sourceUrl": "link"
    }
  }
}

Response

{
  "mongoCredentialId": "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
  "resourceId": "mongo-collection-credal-sync-bfd82450-6c68-11ef-bb2b-f7176fe2f3c4",
  "syncLaunched": true
}