Getting Started

To use the APIs, the client requires a valid API Key and for the client's S3 buckets to be configured to allow access to Subly services.

Authentication

All API requests require the x-api-key header to be set with a valid API key that can be obtained from Subly.

S3 Bucket Configuration

The client S3 bucket needs to be configured to allow Subly API services to read and write to the client bucket.

To allow access to Subly API services, the client bucket must have settings:

• In AWS region eu-west-2 (London)
• Object Ownership set to ACLs Disabled
• Bucket policy set to allow Subly API roles access (see below)

To allow the Subly APIs to read and write from a client bucket, grant the bucket permissions to the following roles

• arn:aws:iam::643462766627:role/subly-api-public-api-prod-eu-west-2-lambdaRole
• arn:aws:iam::643462766627:role/subly-backend-ecs

An example bucket policy for a bucket named my-transcribe-bucket is shown below

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::643462766627:role/subly-api-public-api-prod-eu-west-2-lambdaRole"
      },
      "Action": ["s3:PutObject", "s3:GetObject"],
      "Resource": "arn:aws:s3:::my-transcribe-bucket/*"
    },
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::643462766627:role/subly-backend-ecs"
      },
      "Action": ["s3:PutObject", "s3:GetObject"],
      "Resource": "arn:aws:s3:::my-transcribe-bucket/*"
    }
  ]
}

The client bucket name needs to be provided to Subly to allow the API to gain access.