API docs by Redocly

Swell API (v1)

Download OpenAPI specification:Download

E-mail: [email protected] Terms of Service

The Swell API allows you to access the Swell platform programmatically. You can use the API to upload media and manage your account, and access transcript and generated content.

Content

List Content

Returns a list of all content associated to the Api Key's project.

Authorizations:
Bearer
query Parameters
episode_id
string

Filter by episode id

page
integer

Page for Pagination

size
integer

Page Size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Content

Retrieves Content with it's type and value.

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "type": "summary",
  • "episode": "string"
}

Episode

List Episodes

Returns a list of all episodes associated to the Api Key's project.

Authorizations:
Bearer
query Parameters
page
integer

Page for Pagination

size
integer

Page Size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Episode

Creates an Episode by doing so it will download the media file from the provided URL, transcribe it, and create a various forms of content which will later be available.Each episode created with a production Api Key will be credited against the key's account.

Authorizations:
Bearer
Request Body schema: application/json
name
required
string (Name) non-empty
source
required
string <uri> (Source) non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "string",
  • "environment": "test",
  • "name": "string",
  • "file": "http://example.com",
  • "project": "string",
  • "status": "created",
  • "articles": [
    ],
  • "shownotes": [
    ],
  • "titles": [
    ],
  • "summaries": [
    ]
}

Retrieve Episode

Retrieves an Episode with a list of it's content and status.

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "environment": "test",
  • "name": "string",
  • "file": "http://example.com",
  • "project": "string",
  • "status": "created",
  • "articles": [
    ],
  • "shownotes": [
    ],
  • "titles": [
    ],
  • "summaries": [
    ]
}

Retrieve a Transcript

When available, this endpoint will return the transcript for an episode. The transcript is available only after the episode has been transcribed. Both an .srt and .vtt file are available for download.

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

Account & Billing

Retrieve API Key

Returns the environment, project, account, and billing information for the API key.

Authorizations:
Bearer
query Parameters
page
integer

A page number within the paginated result set.

size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "environment": "test",
  • "account": {
    },
  • "project": {
    }
}