Skip to main content
POST
/
documents
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.documents.uploadJson({ document: {} });

console.log(response.data);
{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "document",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "content_type": "application/pdf",
    "size": {
      "unit": "bytes",
      "amount": 123456
    },
    "status": "pending",
    "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
    "filename": "test-document.pdf",
    "customer_reference": "MY REF 001",
    "av_scan_status": "scanned"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
url
string

If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.

Example:

"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"

​
file
string<byte>

Alternatively, instead of the URL you can provide the Base64 encoded contents of the file you are uploading.

Example:

"ZXhhbXBsZSBvZiBlbmNvZGVkIGNvbnRlbnQ="

​
filename
string

The filename of the document.

Example:

"test-document.pdf"

​
customer_reference
string

A customer reference string for customer look ups.

Example:

"MY REF 001"

Response

Successful response

​
data
object