List Documents In Collection

GET https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection

List documents in a collection

Reference: https://docs.credal.ai/api-reference/api-reference/document-collections/list-documents-in-collection

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

• collectionId (UUID, required) — The ID of the document collection to list documents from.

• resourceIdentifiers (list of ResourceIdentifier, required)

• 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)

Response

{
  "resourceIdentifiers": [
    {
      "type": "external-resource-id",
      "externalResourceId": "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
      "resourceType": "GOOGLE_DRIVE_ITEM"
    },
    {
      "type": "external-resource-id",
      "externalResourceId": "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
      "resourceType": "GOOGLE_DRIVE_ITEM"
    }
  ]
}

SDK Code

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

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.documentCollections.listDocumentsInCollection({
        collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
    });
}
main();

from credal import CredalV0
import uuid

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.document_collections.list_documents_in_collection(
    collection_id=uuid.UUID("82e4b12a-6990-45d4-8ebd-85c00e030c24"),
)