Add Documents To Collection

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

Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the uploadDocumentContents endpoint.

Reference: https://docs.credal.ai/api-reference/api-reference/document-collections/add-documents-to-collection

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 an object.

collectionId (UUID, required) — The ID of the document collection you want to add to.
resourceIdentifiers (list of ResourceIdentifier, required) — The set of resource identifier for which you want to add to the collection.

Types

ResourceIdentifier

type: external-resource-id
- externalResourceId (string, required)
- resourceType (enum, required)
  - Allowed values: GOOGLE_DRIVE_ITEM, MICROSOFT_DRIVE_ITEM, ZENDESK_TICKET, ZENDESK_ARTICLE, ZENDESK_GROUP, ZENDESK_ARTICLE_SECTION, ZENDESK_ARTICLE_CATEGORY, CONFLUENCE_PAGE, CONFLUENCE_SPACE, JIRA_TICKET, JIRA_PROJECT, SALESFORCE_TASK, BOX_FILE, BOX_FOLDER, NOTION_PAGE, NOTION_DATABASE, SLACK_CHANNEL, MONGO_COLLECTION_SYNC, UNKNOWN
type: url
- url (string, required)

Examples

Request

JSON

{
  "collectionId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
  "resourceIdentifiers": [
    {
      "type": "external-resource-id",
      "externalResourceId": "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
      "resourceType": "GOOGLE_DRIVE_ITEM"
    },
    {
      "type": "external-resource-id",
      "externalResourceId": "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
      "resourceType": "GOOGLE_DRIVE_ITEM"
    }
  ]
}

SDK Code

addDocumentsToCollectionExample

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

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.documentCollections.addDocumentsToCollection({
        collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
        resourceIdentifiers: [
            {
                type: "external-resource-id",
                externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
                resourceType: "GOOGLE_DRIVE_ITEM",
            },
            {
                type: "external-resource-id",
                externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
                resourceType: "GOOGLE_DRIVE_ITEM",
            },
        ],
    });
}
main();

addDocumentsToCollectionExample

from credal import CredalV0
import uuid
from credal.common import ResourceIdentifier_ExternalResourceId

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.document_collections.add_documents_to_collection(
    collection_id=uuid.UUID("82e4b12a-6990-45d4-8ebd-85c00e030c24"),
    resource_identifiers=[
        ResourceIdentifier_ExternalResourceId(
            external_resource_id="170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
            resource_type="GOOGLE_DRIVE_ITEM",
        ),
        ResourceIdentifier_ExternalResourceId(
            external_resource_id="398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
            resource_type="GOOGLE_DRIVE_ITEM",
        )
    ],
)