Skip to main content
Automatically polls the job status until it is complete. 
client.jobs.autoRetrieveStatus(jobId: string): Promise<JobStatus>
​
jobId
string
required
The UUID of the job to monitor.

​
Retrieve Status

Retrieve the current status and results of an asynchronous job. The SDK automatically handles job polling for you with autoRetrieveStatus, but if you need to manually track a job (e.g. from an Async method), you can use this method. 
client.jobs.retrieveStatus(jobId: string): Promise<JobStatus>

​
Parameters

​
jobId
string
required
The UUID of the job to check.

​
Usage

const status = await client.jobs.retrieveStatus('550e8400-e29b-41d4-a716-446655440000');

if (status.status === 'completed') {
  console.log('Results:', status.resultData);
}

​
Response

interface JobStatus {
  id: string;
  status: 'queued' | 'processing' | 'completed' | 'failed' | 'waiting_for_browser';
  jobType: 'profile_search' | 'check_friends' | 'find_mutual_friends' | 'verify_profile_photo';
  environment: string;
  resultData?: any;
  errorMessage?: string;
  createdAt: string;
  startedAt: string | null;
  completedAt: string | null;
  browserId?: string;
  browser?: {
    id: string;
    kernelBrowserId: string;
    status: 'idle' | 'busy';
    lastUsedAt: string | null;
  };
}

​
Response Fields

​
Job Statuses

​
Queued

Job is waiting in the queue to be processed.

​
Waiting for Browser

Job is waiting for an available browser instance.

​
Processing

Job is actively being processed.

​
Completed

Job finished successfully. Results are available in the resultData field.

​
Failed

Job encountered an error. Check the errorMessage field for details.