Sync Source By Url

POST https://api.credal.ai/api/v0/catalog/syncSourceByUrl Content-Type: application/json

Sync a document from a source URL. Does not support recursive web search. Reach out to a Credal representative for access.

Reference: https://docs.credal.ai/api-reference/api-reference/document-catalog/sync-source-by-url

Authentication

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

Request

Body (application/json)

This endpoint expects a SyncSourceByUrlRequest.

uploadAsUserEmail (string, required)
sourceUrl (string, required)

Response

200

sourceId (UUID, required)

Examples

Request

JSON

{
  "uploadAsUserEmail": "ria@credal.ai",
  "sourceUrl": "https://drive.google.com/file/d/123456/view"
}

Response

JSON

{
  "sourceId": "82e4b12a-6990-45d4-8ebd-85c00e030c24"
}

SDK Code

Example0

import { CredalClient } from "@credal/sdk";

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.documentCatalog.syncSourceByUrl({
        uploadAsUserEmail: "ria@credal.ai",
        sourceUrl: "https://drive.google.com/file/d/123456/view",
    });
}
main();

Example0

from credal import CredalV0

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.document_catalog.sync_source_by_url(
    upload_as_user_email="ria@credal.ai",
    source_url="https://drive.google.com/file/d/123456/view",
)