Get Avatars

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

// Fetch first page
let response = await fetch('https://api.pictory.ai/pictoryapis/v1/avatars', {
  headers: { 'Authorization': 'YOUR_API_KEY' }
});
let data = await response.json();
let allAvatars = [...data.items];

// Fetch remaining pages
while (data.nextPageKey) {
  response = await fetch(`https://api.pictory.ai/pictoryapis/v1/avatars?nextPageKey=${encodeURIComponent(data.nextPageKey)}`, {
    headers: { 'Authorization': 'YOUR_API_KEY' }
  });
  data = await response.json();
  allAvatars.push(...data.items);
}

console.log('Total avatar groups:', allAvatars.length);

// Step 1: Get available avatars
const avatarsResponse = await fetch('https://api.pictory.ai/pictoryapis/v1/avatars', {
  headers: { 'Authorization': 'YOUR_API_KEY' }
});

const avatarsData = await avatarsResponse.json();

// Step 2: Find an avatar group by name
const annieGroup = avatarsData.items.find(group => group.name === 'Annie');

// Step 3: Select a specific look
const selectedLook = annieGroup.looks.find(look => look.name.includes('Tan Jacket'));

console.log('Selected avatar:');
console.log('  avatarId:', selectedLook.id);
console.log('  Preview:', selectedLook.previewVideo);

// Step 4: Create video with the selected avatar
const videoResponse = await fetch('https://api.pictory.ai/pictoryapis/v2/video/storyboard', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    videoName: 'my_avatar_video',
    language: 'en',
    videoWidth: 1920,
    videoHeight: 1080,
    voiceOver: {
      enabled: true,
      aiVoices: [{
        speaker: 'Matthew',
        speed: 100
      }]
    },
    avatar: {
      avatarId: selectedLook.id,           // "Annie_expressive12_public"
      position: 'bottom-right',
      width: '20%'
    },
    scenes: [{
      story: 'Welcome to my video!',
      createSceneOnEndOfSentence: true,
      minimumDuration: 4
    }]
  })
});

const videoData = await videoResponse.json();
console.log('Video job created:', videoData.data.jobId);

const avatarsData = await getAvatars();

// Filter by gender
const femaleAvatars = avatarsData.items.filter(group => group.gender === 'Female');
const maleAvatars = avatarsData.items.filter(group => group.gender === 'Male');

// Get all looks for female avatars
const femaleLooks = femaleAvatars.flatMap(group =>
  group.looks.map(look => ({
    avatarId: look.id,
    lookName: look.name,
    gender: group.gender
  }))
);

// Find specific avatar by name
const caroline = avatarsData.items.find(group => group.name === 'Caroline');
const carolineLooks = caroline ? caroline.looks : [];

// Search for looks by outfit
const suitLooks = avatarsData.items.flatMap(group =>
  group.looks.filter(look => look.name.toLowerCase().includes('suit'))
);

console.log('Female avatars:', femaleAvatars.length);
console.log('Male avatars:', maleAvatars.length);
console.log('Suit looks:', suitLooks.length);