The Swell API uses API Keys to authenticate requests. You can view and manage your API keys in your project’s API Source.
\nTest mode secret keys have the prefix sk_test_ and live mode secret keys have the prefix sk_live_.
Authentication to the API is performed via bearer auth, ex: \"Authorization: Bearer sk_test_your_key\" instead of -u sk_test_your_key.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\nThe base url for all requests is https://api.swellai.com/v2.
This API supports pagination to help you efficiently retrieve a list of resources associated with the API Key's project. You can control the number of results per page and navigate through the result pages using the page and size query parameters.
page (integer, optional, default: 1): The page number you want to retrieve. The default value is 1, which returns the first page of results.size (integer, optional, default: 10): The number of results per page. The default value is 10.GET /v2/resources?page=2&size=20\nAuthorization: Bearer your_api_key\n\nThe response will include the following fields:
\ncount (integer): The total number of results matching your query.next (string, nullable): The URL for the next page of results, or null if there are no more pages.previous (string, nullable): The URL for the previous page of results, or null if you are on the first page.results (array): An array of objects containing the content for the current page.{\n \"count\": 50,\n \"next\": \"/v2/resources?page=3&size=20\",\n \"previous\": \"/v2/resources?page=1&size=20\",\n \"results\": [...]\n}\n\nTo create an episode, you must provide
\nUpon creation, the Episode will move to a processing state until it's the file is download and transcribed. If there are any errors, the Episode will be moved to a failed state.
Once the Episode is downloaded and transcribed it will be moved to a ready state. This will indicate that the applied Templates will generate Content.
For the test environment, the Episode will move immediately into a ready state. Note that it usually takes 10 minutes per hour of content to download & transcribe. So this will not be instantaneous in production.
In addition, Content will immediately be produced but with fixture data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"In the context of the Swell API, an Episode is a resource that represents an audio or video file. It is important to note that Episodes are not limited to traditional podcast episodes. They can also represent other types of audio or video files such as audiobooks, lectures, or music albums. The flexibility of the Episode resource in the Swell API allows for a wide range of use cases and enables developers to create unique and innovative applications that leverage Swell's audio processing capabilities.
\nIf the Content’s status is ready we will return the markdown value in plain text. Otherwise we will return a 400 status code.
This resource represents generated content from a template that is applied to an episode. Content is stored in a portable markdown format. In later versions it may be possible to see individual blocks which compose a Content resource.
\n