Batch Move Documents | Speechify API

curl -X PATCH https://api.speechify.ai/v1/agents/knowledge-bases/kb_01jqr8x9zg5k2m3n4p5q6r7s8t/documents/batch \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "ids": [
    "doc_01knthz1d4v2bn8y9wz5ewjagk",
    "doc_01knthz1d4v2bn8y9wz5ewjagl",
    "doc_01knthz1d4v2bn8y9wz5ewjagm"
  ],
  "folder_id": "kfolder_01krdk9hzct70r12s7z5a4xtsh"
}'

{
  "documents": [
    {
      "id": "doc_01knthz1d4v2bn8y9wz5ewjagk",
      "kb_id": "kb_01jqr8x9zg5k2m3n4p5q6r7s8t",
      "source_kind": "file",
      "folder_id": "kfolder_01krdk9hzct70r12s7z5a4xtsh",
      "filename": "Acme_Inc_Employee_Handbook.pdf",
      "content_type": "application/pdf",
      "byte_size": 254321,
      "char_count": 10240,
      "chunk_count": 25,
      "status": "ready",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-04-10T14:45:00Z",
      "content_preview": "Welcome to Acme Inc! This handbook provides important information about company policies, benefits, and workplace expectations...",
      "preview_truncated": true,
      "dependent_agents": [
        {
          "id": "agent_01jqr8x9zg5k2m3n4p5q6r7s8t",
          "name": "Cliff Weitzman Assistant"
        }
      ],
      "source_url": "",
      "error": "",
      "refresh": {
        "enabled": false,
        "interval_days": 0,
        "auto_remove_enabled": false,
        "last_refreshed_at": "",
        "consecutive_fetch_failures": 0
      }
    },
    {
      "id": "doc_01knthz1d4v2bn8y9wz5ewjagl",
      "kb_id": "kb_01jqr8x9zg5k2m3n4p5q6r7s8t",
      "source_kind": "url",
      "folder_id": "kfolder_01krdk9hzct70r12s7z5a4xtsh",
      "filename": "Code_of_Conduct.html",
      "content_type": "text/html",
      "byte_size": 15342,
      "char_count": 6789,
      "chunk_count": 8,
      "status": "ready",
      "created_at": "2024-02-20T11:00:00Z",
      "updated_at": "2024-04-10T14:50:00Z",
      "content_preview": "At Acme Inc, we expect all employees to uphold the highest standards of integrity and professionalism...",
      "preview_truncated": true,
      "dependent_agents": [
        {
          "id": "agent_01jqr8x9zg5k2m3n4p5q6r7s8t",
          "name": "Cliff Weitzman Assistant"
        }
      ],
      "source_url": "https://www.acmeinc.com/policies/code-of-conduct",
      "error": "",
      "refresh": {
        "enabled": true,
        "interval_days": 7,
        "auto_remove_enabled": true,
        "last_refreshed_at": "2024-04-03T10:00:00Z",
        "consecutive_fetch_failures": 0
      }
    },
    {
      "id": "doc_01knthz1d4v2bn8y9wz5ewjagm",
      "kb_id": "kb_01jqr8x9zg5k2m3n4p5q6r7s8t",
      "source_kind": "text",
      "folder_id": "kfolder_01krdk9hzct70r12s7z5a4xtsh",
      "filename": "Meeting_Notes_March_2024.txt",
      "content_type": "text/plain",
      "byte_size": 2048,
      "char_count": 1800,
      "chunk_count": 3,
      "status": "ready",
      "created_at": "2024-03-05T15:20:00Z",
      "updated_at": "2024-04-10T14:55:00Z",
      "content_preview": "March 2024 team meeting covered project updates, upcoming deadlines, and action items for the next quarter...",
      "preview_truncated": true,
      "dependent_agents": [
        {
          "id": "agent_01jqr8x9zg5k2m3n4p5q6r7s8t",
          "name": "Cliff Weitzman Assistant"
        }
      ],
      "source_url": "",
      "error": "",
      "refresh": {
        "enabled": false,
        "interval_days": 0,
        "auto_remove_enabled": false,
        "last_refreshed_at": "",
        "consecutive_fetch_failures": 0
      }
    }
  ]
}

Move multiple documents into a folder in a single transaction. Pass folder_id: null to move every doc to root. Capped at 200 ids per call. Returns the moved documents.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

kb_idstringRequired

Knowledge base id (prefixed external id, kb_...).

Request

This endpoint expects an object.

idslist of stringsRequired

folder_idstring or nullRequired

Destination folder. Prefixed wire identifier (kfolder_<26 char Crockford base32>); null moves every document to the knowledge base root.

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

The moved documents.

documentslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error