For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
      • GETGet a document by ID
      • POSTTrigger processing for uploaded documents
      • GETList documents
      • POSTReserve a document upload slot
      • DELDelete documents by ID
Get API Key
LogoLogo
API ExplorerDocuments

Delete documents by ID

DELETE
/api/v2/documents
DELETE
/api/v2/documents
$curl -X DELETE https://api-staging.pyramid-ai.com/api/v2/documents \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "document_ids": [
>    "doc_9f8b7c6a-1234-4d56-8e9f-abcdef123456"
>  ]
>}'
1{
2  "request_id": "req_20240615_abcdef1234567890",
3  "success": true,
4  "data": {
5    "deleted": [
6      "doc_9f8b7c6a-1234-4d56-8e9f-abcdef123456"
7    ]
8  },
9  "pagination": {
10    "total": 1,
11    "offset": 0,
12    "limit": 50
13  }
14}
Was this page helpful?
Previous

Get the organization for the current API key

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
document_idslist of stringsRequired

Response

Documents deleted
request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany
dataobject
paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error