API Reference

Get current user

GET https://api.captioned.carescribe.io/me

This endpoint allows you to see the information about the currently authenticated user.

Headers

Name	Type	Description
Accept	string	Must be application/vnd.captioned.v1
Authorization	string	Bearer token. See Authentication docs.

200 Successful

{
  "data": {
    "id": "12345678-abcd-abcd-abcd-abcdef012345",
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "name": "Jane Doe",
      "id": "12345678-abcd-abcd-abcd-abcdef012345"
    }
  }
}

401 You've not got a valid authentication token

Create a media object

POST https://api.captioned.carescribe.io/medias

Creates a media object that provides you a signed URL to upload your media for transcription

Headers

Name	Type	Description
Accept	string	Must be application/vnd.captioned.v1
Authorization	string	Bearer token. See Authentication docs.

Request Body

Name	Type	Description
media	object
↳ content_type	string	Mime type of the data. Must be one of: "audio/mpeg", "audio/wav", "video/mp4", "video/mpeg" or "audio/aac"

201 Successful

{
  "data": {
    "id": "12345678-abcd-abcd-abcd-abcdef012345",
    "type": "media",
    "attributes": {
      "uuid": "12345678-abcd-abcd-abcd-abcdef012345",
      "signed_url_for_upload": "https://storage.googleapis.com/<some_signed_path>",
      "content_type": "audio/mpeg"
    }
  }
}

Direct upload to Google Storage

PUT https://storage.googleapis.com/:path

Upload your file directly to Google Cloud storage.

Path Parameters

Name	Type	Description
path	string	The path is provided as part the signed_url_for_upload attibute when creating a media object. You should make your request to the whole URL provided.

Headers

Name	Type	Description
Content-Type	string	Must be the same content type given when creating the media object.

Request Body

Name	Type	Description
body	string	Binary contents of the file you are uploading

200

Empty

Create a transcription

POST https://api.captioned.carescribe.io/transcriptions

Create a transcription from your Media object

Headers

Name	Type	Description
Accept	string	Must be application/vnd.captioned.v1
Authorization	string	Bearer token. See Authentication docs.

Request Body

Name	Type	Description
source	object
↳ type	string	Must be media
↳ id	string	The ID of the media to create a transcription for

201 Sucessfully created

{
  "data": {
    "id": null,
    "type": "transcription",
    "attributes": {
      "id": "12345678-abcd-abcd-abcd-abcdef012345"
    },
    "relationships": {
      "transcript_result": {
        "data": null
      },
      "transcription_sessions": {
        "data": [
          {
            "id": "12345678-abcd-abcd-abcd-abcdef012345",
            "type": "transcription_session"
          }
        ]
      }
    }
  }
}

Retrieve a transcription

GET https://api.captioned.carescribe.io/transcriptions/:id

Retrieve a previously created transcription

Path Parameters

Name	Type	Description
id	string	The ID of the transcription you are requesting

Headers

Name	Type	Description
Accept	string	Must be application/vnd.captioned.v1
Authorization	string	Bearer toke. See Authentication docs.

200

{
  "data": {
    "id": null,
    "type": "transcription",
    "attributes": {
      "id": "12345678-abcd-abcd-abcd-abcdef012345"
    },
    "relationships": {
      "transcript_result": {
        "data": null
      },
      "transcription_sessions": {
        "data": [
          {
            "id": "12345678-abcd-abcd-abcd-abcdef012345",
            "type": "transcription_session"
          }
        ]
      }
    }
  }
}