Add Documents

POST /v2/organizations/documents/add

Add Documents

cURL

curl --request POST \
  --url https://api.velt.dev/v2/organizations/documents/add \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "createOrganization": true,
    "documents": [
      {}
    ],
    "folderId": "<string>",
    "createFolder": true
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Document(s) added successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Added Successfully"
      }
    }
  }
}

Use this API to add documents with metadata to an organization.

Endpoint

POST https://api.velt.dev/v2/organizations/documents/add

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

createOrganization · boolean

If set to true, a new organization will be created (if it doesn’t exist) before the document(s) are created.

documents · Document[] · required

Array of Document objects

folderId · string

Folder ID to add the documents to.

createFolder · boolean

If set to true and folderId is provided but doesn’t exist, a new folder will be created before the document(s) are created.

Example Requests

1. Create new documents

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documents": [
      {
        "documentId": "yourDocumentId",
        "documentName": "Your Document Name"
      }
    ]
  }
}

2. Create new documents in a specific folder

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documents": [
      {
        "documentId": "yourDocumentId",
        "documentName": "Your Document Name"
      }
    ],
    "folderId": "yourFolderId"
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Document(s) added successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Added Successfully"
      }
    }
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Partial Failures

When only some of the documents in the batch fail, this endpoint returns HTTP 500 and puts a per-item breakdown in error.details, keyed by the document IDs you sent.

A partial failure is reported as 500 INTERNAL even when nothing actually went wrong on the server, such as when a document simply does not exist. Branch on the per-item code rather than the HTTP status when deciding whether to retry. Retrying on the status alone will loop on already-exists, which will never succeed.

code · string

Why this particular item failed. Present on every entry with "success": false.

Value	Meaning	Safe to retry?
already-exists	A document with this ID already exists.	No
internal	A genuine server-side failure.	Yes

{
  "error": {
    "status": "INTERNAL",
    "message": "Error adding document(s).",
    "details": {
      "yourDocumentId1": {
        "success": true,
        "id": "8121657101517513",
        "message": "Added Successfully"
      },
      "yourDocumentId2": {
        "success": false,
        "id": "yourDocumentId2",
        "message": "Document already exists",
        "code": "already-exists"
      }
    }
  }
}

{
  "result": {
    "status": "success",
    "message": "Document(s) added successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Added Successfully"
      }
    }
  }
}