Metadata

PATCH/v0/catalog/metadataMetadata

Bulk patch metadata for documents, synced natively by Credal or manual API uploads

Request body

application/json

objectdocumentCatalog_DocumentMetadataPatchRequest

DocumentMetadataPatchRequest

sourcesarray of objectrequired

Show child attributes

Show array items

metadataobjectrequired

Key-value object of metadata for document. Keys will be merged with any existing values but can also be set to `null` to effectively remove

resourceIdentifiervaluerequired

Show child attributes

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

uploadAsUserEmailstringrequired

Example request

{
  "sources": [
    {
      "metadata": {
        "additionalProp1": null
      },
      "resourceIdentifier": {
        "externalResourceId": "string",
        "resourceType": "BOX_FILE",
        "type": "external-resource-id"
      }
    }
  ],
  "uploadAsUserEmail": "string"
}

Responses

Examples

curl -X PATCH 'https://api.credal.ai/api/v0/catalog/metadata' \
  -H 'Content-Type: application/json' \
  -d '{"sources":[{"metadata":{"additionalProp1":null},"resourceIdentifier":{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}}],"uploadAsUserEmail":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/catalog/metadata', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"sources":[{"metadata":{"additionalProp1":null},"resourceIdentifier":{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}}],"uploadAsUserEmail":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/catalog/metadata', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"sources\":[{\"metadata\":{\"additionalProp1\":null},\"resourceIdentifier\":{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}}],\"uploadAsUserEmail\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.credal.ai/api/v0/catalog/metadata",
    headers={"Content-Type": "application/json"},
    data='{"sources":[{"metadata":{"additionalProp1":null},"resourceIdentifier":{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}}],"uploadAsUserEmail":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"sources":[{"metadata":{"additionalProp1":null},"resourceIdentifier":{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}}],"uploadAsUserEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.credal.ai/api/v0/catalog/metadata", 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/catalog/metadata");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"sources\":[{\"metadata\":{\"additionalProp1\":null},\"resourceIdentifier\":{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}}],\"uploadAsUserEmail\":\"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/catalog/metadata"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"sources\":[{\"metadata\":{\"additionalProp1\":null},\"resourceIdentifier\":{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}}],\"uploadAsUserEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/catalog/metadata")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"sources\":[{\"metadata\":{\"additionalProp1\":null},\"resourceIdentifier\":{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}}],\"uploadAsUserEmail\":\"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.Patch, "https://api.credal.ai/api/v0/catalog/metadata");
request.Content = new StringContent("{\"sources\":[{\"metadata\":{\"additionalProp1\":null},\"resourceIdentifier\":{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}}],\"uploadAsUserEmail\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 200)

Search documentation

copilots

documentCatalog

documentCollections

search

users