TypeScript SDK

const executionId = await executeAgent(client, 'YOUR_AGENT_ID', {
  dynamic_data: {
    DATA: "First name: John, Last name: Smith"
  },
  agent_profile_id: 'YOUR_AGENT_PROFILE_ID'
});

const status = await getExecutionStatus(client, executionId);
console.log(status.status);

const result = await getExecutionResult(client, executionId);
console.log(result);

const result = await waitForExecutionResult(client, executionId, 2000);

const client = AsteroidClient('YOUR_API_KEY');

import { readFileSync } from 'fs';

const pdfFile = new File([readFileSync('document.pdf')], 'document.pdf', { type: 'application/pdf' });
const files = [pdfFile];
const result = await uploadExecutionFiles(client, executionId, files);
console.log(result.file_ids);

const files = await getExecutionFiles(client, 'execution_123');
files.forEach(file => {
  console.log(`File: ${file.fileName}, Size: ${file.fileSize}`);
});

const files = await getExecutionFiles(client, 'execution_123');
for (const file of files) {
  // Download to specific directory
  const savedPath = await downloadExecutionFile(client, file, './downloads/');
  console.log(`Downloaded ${file.fileName} to ${savedPath}`);
}

const recording = await getBrowserSessionRecording(client, executionId);
console.log(recording.recording_url);

const profiles = await getAgentProfiles(client, 'org-123');

const profile = await getAgentProfile(client, 'profile_123');

const profile = await createAgentProfile(client, {
  name: 'My Profile',
  description: 'Profile description',
  organization_id: 'org_123',
  proxy_cc: 'us',
  proxy_type: 'residential',
  captcha_solver_active: false,
  sticky_ip: false,
  credentials: [],
  cookies: [
    {
      // Display name for the cookie in UI
      name: 'Session Cookie',
      // The actual cookie key and value
      key: 'session_id',
      value: 'abc123',
      // Required domain scope for the cookie
      domain: '.example.com',
      // Security attributes
      secure: true,
      http_only: true,
      same_site: 'Lax', // 'Strict' | 'Lax' | 'None'
      // Optional expiry in ISO 8601
      expiry: '2026-01-01T00:00:00Z',
      // Required created_at in ISO 8601
      created_at: new Date().toISOString()
    }
  ]
});

// Add and remove cookies in the same request
const updated = await updateAgentProfile(client, 'profile_123', {
  name: 'New Name',
  cookies_to_add: [
    {
      name: 'Auth Token',
      key: 'auth_token',
      value: 'new-token-value',
      domain: '.example.com',
      secure: true,
      http_only: true,
      same_site: 'Strict'
    }
  ],
  cookies_to_delete: ['cookie_id_to_remove']
});

// Cookie object shape
type Cookie = {
  id?: string;           // Only present on existing cookies
  name: string;          // Display name
  key: string;           // Cookie name
  value: string;         // Cookie value
  domain: string;        // e.g. '.example.com'
  secure: boolean;       // Send over HTTPS only
  http_only: boolean;    // Not accessible to JS
  same_site: 'Strict' | 'Lax' | 'None';
  expiry?: string;       // ISO 8601 (optional)
  created_at: string;    // ISO 8601
};

await deleteAgentProfile(client, 'profile_123');