Skip to main content
Telnyx documentation is published for browser-based development and direct machine consumption. Use the smallest authoritative source that contains the required context.

​
Documentation formats

  • Documentation index: product and subsection indexes designed for selective retrieval by an AI agent.
  • Complete documentation: consolidated guide content for tools that require a complete documentation corpus.
  • API error catalog: normalized API and product errors with scope, source provenance, and remediation metadata.
  • Webhook event catalog: concrete callback payloads, media types, source specifications, and publication selectors.

​
Page-level Markdown

Append .md to a documentation page URL to retrieve clean Markdown for that page. For example:
Interactive browser controls are excluded from agent-facing Markdown. When an interactive component carries documentation value, its Markdown export contains a concise text fallback or an authoritative machine-readable source instead of the component implementation.

​
OpenAPI and API reference

Use the consolidated OpenAPI specification for REST paths, request and response schemas, and webhook definitions. Published endpoint pages provide the corresponding API reference and ordered samples for:
  • JavaScript
  • Python
  • Go
  • Java
  • Ruby
  • PHP
  • Telnyx CLI
Use the OpenAPI operation as the contract. Use authored guides for product setup, lifecycle constraints, and operational behavior that cannot be represented completely in a schema.

​
Production integration path

Apply this sequence when implementing a Telnyx API integration:
  1. Select the relevant product quickstart or guide from the documentation index.
  2. Inspect the endpoint request, response, and language sample in the API reference.
  3. Implement authentication according to API authentication.
  4. Handle retryable and terminal failures using API error codes and the machine-readable error catalog.
  5. If the product emits callbacks, implement signature verification, asynchronous processing, deduplication, and product-specific retry handling from Webhook fundamentals.
  6. Retrieve exact callback payloads from the webhook event catalog.
  7. Apply rate-limit handling and command retry guidance.

​
Source selection

  • Product setup or workflow: authored guide Markdown.
  • Endpoint contract: API reference or OpenAPI.
  • Language-specific request: endpoint code sample.
  • API failure: error guide and error catalog.
  • Callback payload: webhook reference and webhook catalog.
  • Broad retrieval: subsection llms.txt index before a full-content export.
Do not infer a universal webhook retry schedule or payload envelope. Delivery behavior, event fields, and correlation identifiers can differ by product. Follow the product-specific source linked by the corresponding catalog entry.