Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Documents API

Documents

Telnyx Documents API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

8 operations 5 paths 8 schemas 1 DELETE5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Documents API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 8

Documents

GET
/document_links
List all document links
ListDocumentLinks 2 params → 200422default
GET
/documents
List all documents
ListDocuments 3 params → 200422default
POST
/documents
Upload a document
CreateDocument body → 200422default
DELETE
/documents/{id}
Delete a document
DeleteDocument 1 param → 200422default
GET
/documents/{id}
Retrieve a document
RetrieveDocument 1 param → 200422default
PATCH
/documents/{id}
Update a document
UpdateDocument 1 param body → 200422default
GET
/documents/{id}/download
Download a document
DownloadDocument 1 param → 200422default
GET
/documents/{id}/download_link
Generate a temporary download link for a document
getDocumentDownloadLink 1 param → 200404422default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are documents_Error (5 properties), CreateDocServiceDocumentRequest (4 properties), DocServiceRecord (4 properties), PaginationMeta (4 properties). Each schema is shown below with its type and property counts.

DocServiceDocumentLink
DocServiceRecord
object
4 properties
CreateMultiPartDocServiceDocumentRequest
object
2 properties
documents_Error
object
5 properties 2 required
documents_Errors
object
1 property
PaginationMeta
object
4 properties
DocServiceDocument
CreateDocServiceDocumentRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-documents-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API