Create Mongo Collection Sync

POST/v0/documentCollections/mongodb/createMongoSyncCreate Mongo Collection Sync

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.

Request body

application/json

object

collectionIdstring · uuidrequired

configobjectrequired

Show child attributes

collectionNamestringrequired

filterExpressionvaluerequired

Any type

sourceFieldsobjectrequired

Show child attributes

bodystringrequired

sourceNamestringrequired

sourceSystemUpdatedstring

sourceUrlstring

syncNamestringrequired

mongoURIstringrequired

Example request

{
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "config": {
    "collectionName": "string",
    "filterExpression": null,
    "sourceFields": {
      "body": "string",
      "sourceName": "string",
      "sourceSystemUpdated": "string",
      "sourceUrl": "string"
    },
    "syncName": "string"
  },
  "mongoURI": "string"
}

Responses

objectdocumentCollections_MongoCollectionSyncResponse

MongoCollectionSyncResponse

mongoCredentialIdstring · uuidrequired

resourceIdstringrequired

syncLaunchedbooleanrequired

Example response

{
  "mongoCredentialId": "00000000-0000-0000-0000-000000000000",
  "resourceId": "string",
  "syncLaunched": true
}

Examples

curl -X POST 'https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync' \
  -H 'Content-Type: application/json' \
  -d '{"collectionId":"00000000-0000-0000-0000-000000000000","config":{"collectionName":"string","filterExpression":null,"sourceFields":{"body":"string","sourceName":"string","sourceSystemUpdated":"string","sourceUrl":"string"},"syncName":"string"},"mongoURI":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"collectionId":"00000000-0000-0000-0000-000000000000","config":{"collectionName":"string","filterExpression":null,"sourceFields":{"body":"string","sourceName":"string","sourceSystemUpdated":"string","sourceUrl":"string"},"syncName":"string"},"mongoURI":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"config\":{\"collectionName\":\"string\",\"filterExpression\":null,\"sourceFields\":{\"body\":\"string\",\"sourceName\":\"string\",\"sourceSystemUpdated\":\"string\",\"sourceUrl\":\"string\"},\"syncName\":\"string\"},\"mongoURI\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync",
    headers={"Content-Type": "application/json"},
    data='{"collectionId":"00000000-0000-0000-0000-000000000000","config":{"collectionName":"string","filterExpression":null,"sourceFields":{"body":"string","sourceName":"string","sourceSystemUpdated":"string","sourceUrl":"string"},"syncName":"string"},"mongoURI":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"collectionId":"00000000-0000-0000-0000-000000000000","config":{"collectionName":"string","filterExpression":null,"sourceFields":{"body":"string","sourceName":"string","sourceSystemUpdated":"string","sourceUrl":"string"},"syncName":"string"},"mongoURI":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"config\":{\"collectionName\":\"string\",\"filterExpression\":null,\"sourceFields\":{\"body\":\"string\",\"sourceName\":\"string\",\"sourceSystemUpdated\":\"string\",\"sourceUrl\":\"string\"},\"syncName\":\"string\"},\"mongoURI\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"config\":{\"collectionName\":\"string\",\"filterExpression\":null,\"sourceFields\":{\"body\":\"string\",\"sourceName\":\"string\",\"sourceSystemUpdated\":\"string\",\"sourceUrl\":\"string\"},\"syncName\":\"string\"},\"mongoURI\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"config\":{\"collectionName\":\"string\",\"filterExpression\":null,\"sourceFields\":{\"body\":\"string\",\"sourceName\":\"string\",\"sourceSystemUpdated\":\"string\",\"sourceUrl\":\"string\"},\"syncName\":\"string\"},\"mongoURI\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.credal.ai/api/v0/documentCollections/mongodb/createMongoSync");
request.Content = new StringContent("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"config\":{\"collectionName\":\"string\",\"filterExpression\":null,\"sourceFields\":{\"body\":\"string\",\"sourceName\":\"string\",\"sourceSystemUpdated\":\"string\",\"sourceUrl\":\"string\"},\"syncName\":\"string\"},\"mongoURI\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "mongoCredentialId": "00000000-0000-0000-0000-000000000000",
  "resourceId": "string",
  "syncLaunched": true
}

Search documentation

copilots

documentCatalog

documentCollections

search

users