POST
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
uploads
/
{upload_id}
/
cancel
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const cancelKnowledgeBaseUploadResponse = await client.knowledgeBases.uploads.cancel(
  'knowledge_base_id',
  'upload_id',
);

console.log(cancelKnowledgeBaseUploadResponse.upload_id);
{
  "upload_id": "<string>",
  "canceled": true
}

Authorizations

x-api-key
string
header
required

Path Parameters

knowledge_base_id
string
required
upload_id
string
required

Response

Successful Response

upload_id
string
required

ID of the knowledge base upload job that was cancelled.

canceled
boolean
required

Whether cancellation was successful.