Skip to main content
GET
/
pictoryapis
/
v1
/
awsconnections
Get AWS Private Connections
curl --request GET \
  --url https://api.pictory.ai/pictoryapis/v1/awsconnections \
  --header 'Authorization: <authorization>'
{
  "Items": [
    {
      "connectionId": "20251217080657842fux3au9kh1p0j5s",
      "name": "TestAWSConnection",
      "description": "Test AWS Connection for Documentation",
      "awsAccountId": "123456789012",
      "awsRegion": "us-east-2",
      "type": "AWS",
      "enabled": true,
      "createdDate": "2025-12-17T08:06:56.862Z",
      "updatedDate": "2025-12-17T08:06:56.862Z",
      "version": 1
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.pictory.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint retrieves a list of all AWS S3 private connections you have configured for your Pictory account. Use this to view your existing connections, check their status, and get connection IDs for use in video creation requests.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.

​
Use Cases

View All Connections

See all your configured AWS S3 connections in one place

Get Connection IDs

Retrieve connection IDs to use in video creation requests

Check Status

Verify which connections are currently enabled or disabled

Audit Configuration

Review your AWS account IDs and regions

​
API Endpoint

GET https://api.pictory.ai/pictoryapis/v1/awsconnections

​
Request Parameters

​
Headers

​
Authorization
string
required
API key for authentication (starts with pictai_)
Authorization: YOUR_API_KEY
Get your API key from the API Access page in your Pictory dashboard.

​
Response

Returns an array of AWS connection objects in the Items field. If no connections are configured, returns an empty array.

​
Response Examples

{
  "Items": [
    {
      "connectionId": "20251217080657842fux3au9kh1p0j5s",
      "name": "TestAWSConnection",
      "description": "Test AWS Connection for Documentation",
      "awsAccountId": "123456789012",
      "awsRegion": "us-east-2",
      "type": "AWS",
      "enabled": true,
      "createdDate": "2025-12-17T08:06:56.862Z",
      "updatedDate": "2025-12-17T08:06:56.862Z",
      "version": 1
    }
  ]
}

​
Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_
# Retrieve all AWS connections
# Replace YOUR_API_KEY with your actual API key

curl --request GET \
  --url https://api.pictory.ai/pictoryapis/v1/awsconnections \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'accept: application/json' | python -m json.tool

​
Common Use Cases

​
Find Connection ID for Video Creation

When creating videos with private S3 assets, you need to provide the awsConnectionId. Use this endpoint to retrieve it: 
// Get all connections and find the one you need
const result = await getAwsConnections(apiKey);
const myConnection = result.Items.find(conn => conn.name === 'PictoryPrivateVideosConnection');

if (myConnection) {
  console.log('Use this ID in video requests:', myConnection.connectionId);
}

​
Check if Connections are Enabled

result = get_aws_connections(api_key)

for connection in result['Items']:
    status = "Active" if connection['enabled'] else "Disabled"
    print(f"{connection['name']}: {status}")

​
List All Regions

const result = await getAwsConnections(apiKey);
const regions = result.Items.map(conn => conn.awsRegion);
console.log('Configured regions:', [...new Set(regions)]);

​
Next Steps

Create AWS Connection

Set up a new AWS S3 private connection

Use in Videos

Learn how to use connection IDs in video creation

Get API Key

Access your API key from your Pictory dashboard

Troubleshooting

Common issues and solutions