List Documents In Collection

GET/v0/documentCollections/listDocumentsInCollectionList Documents In Collection

List documents in a collection

Parameters

collectionIdstring · uuidqueryrequired

The ID of the document collection to list documents from.

Responses

objectdocumentCollections_ListDocumentsInCollectionResponse

ListDocumentsInCollectionResponse

resourceIdentifiersarray of valuerequired

Show child attributes

Show array items

oneOf · 2 options

Option 1object

externalResourceIdstringrequired

resourceTypestringrequired

one of "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"

typestringrequired

Discriminator value: external-resource-id

one of "external-resource-id"

Option 2object

typestringrequired

Discriminator value: url

one of "url"

urlstringrequired

Example response

{
  "resourceIdentifiers": [
    {
      "externalResourceId": "string",
      "resourceType": "BOX_FILE",
      "type": "external-resource-id"
    }
  ]
}

Examples

collectionIdrequiredquery parameter

curl -X GET 'https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000'

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		panic(err)
	}
	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/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "https://api.credal.ai/api/v0/documentCollections/listDocumentsInCollection?collectionId=00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "resourceIdentifiers": [
    {
      "externalResourceId": "string",
      "resourceType": "BOX_FILE",
      "type": "external-resource-id"
    }
  ]
}

Search documentation

copilots

documentCatalog

documentCollections

search

users