API Overview

Wordcab's API takes a conversation - whether it's in the form of an audio file, a .vtt file, or a JSON object, among other supported formats - and returns a summary, along with other useful insights.

To make the summary process as simple and intuitive as possible, Wordcab's API is split into several logical components. The API accepts one of a number of Sources to summarize. Each summary process is called a Job, which can consist of Transcript and Summary objects. More details below:

  • Jobs: Jobs are created whenever you initiate a new process - whether this is transcription, summarization, or anything else. Each job has a job_name that you can use to poll for status (see the Job Status guide) and retrieve other useful data.
  • Sources: We accept a variety of input sources. For more on the types of sources we accept, please see the Accepted Sources guide.
  • Transcripts: Wordcab's API accepts audio or text as input, and transforms it into a structured Transcript, which can be used (and re-used) for downstream tasks such as summarization and topic extraction.
  • Summaries: Wordcab's bread-and-butter. Summaries are highly-condensed versions of transcripts, often reducing read times by over 90%.
  • Summary Types: Wordcab is capable of generating a variety of customizable summary types, including narrative summaries, short summaries, and focused summaries. Check out Summary Types for more details.

The following set of guides will introduce the mechanics of the Wordcab API, and walk you through a number of practical use cases.

What’s Next

In the next section, you'll learn where to find your API key in your API Hub. Then in the Quickstart guide, we'll jump straight into a brief example where we summarize a text transcript - reducing its read-time by 10x - and then further condense the information into a single-sentence summary. Happy summarizing!

Did this page help you?