BuildClient

Client for managing a specific Actor build.

Builds are created when an Actor is built from source code. This client provides methods to get build details, wait for the build to finish, abort it, and access its logs.

Hierarchy

• ResourceClient
  • BuildClient

const client = new ApifyClient({ token: 'my-token' });
const buildClient = client.build('my-build-id');

// Get build details
const build = await buildClient.get();

// Wait for the build to finish
const finishedBuild = await buildClient.waitForFinish();

// Access build logs
const log = await buildClient.log().get();

See more at https://docs.apify.com/platform/actors/running/runs-and-builds#builds

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• resourcePath
• safeId
• url

Methods

• abort
• delete
• get
• getOpenApiDefinition
• log
• waitForFinish

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

abort

• abort(): Promise<Build>

• Aborts the Actor build.

  Stops the build process immediately. The build will have an ABORTED status.

  ---

  Returns Promise<Build>

  The updated Build object with ABORTED status

  await client.build('build-id').abort();

  See more at https://docs.apify.com/api/v2/actor-build-abort-post

delete

• delete(): Promise<void>

• Deletes the Actor build.

  ---

  Returns Promise<void>

  See more at https://docs.apify.com/api/v2/actor-build-delete

get

• get(options): Promise<undefined | Build>

• Gets the Actor build object from the Apify API.

  ---

  Parameters

  • options: BuildClientGetOptions = {}

    Get options

  Returns Promise<undefined | Build>

  The Build object, or undefined if it does not exist

  // Get build status immediately
  const build = await client.build('build-id').get();
  console.log(`Status: ${build.status}`);
  
  // Wait up to 60 seconds for build to finish
  const build = await client.build('build-id').get({ waitForFinish: 60 });

  See more at https://docs.apify.com/api/v2/actor-build-get

getOpenApiDefinition

• getOpenApiDefinition(): Promise<OpenApiDefinition>

• Retrieves the OpenAPI definition for the Actor build.

  ---

  Returns Promise<OpenApiDefinition>

  The OpenAPI definition object.

  See more at https://docs.apify.com/api/v2/actor-build-openapi-json-get

log

• log(): LogClient

• Returns a client for accessing the log of this Actor build.

  ---

  Returns LogClient

  A client for accessing the build's log

  // Get build log
  const log = await client.build('build-id').log().get();
  console.log(log);

  See more at https://docs.apify.com/api/v2/actor-build-log-get

waitForFinish

• waitForFinish(options): Promise<Build>

• Waits for the Actor build to finish and returns the finished Build object.

  The promise resolves when the build reaches a terminal state (SUCCEEDED, FAILED, ABORTED, or TIMED-OUT). If waitSecs is provided and the timeout is reached, the promise resolves with the unfinished Build object (status will be RUNNING or READY). The promise is NOT rejected based on build status.

  Unlike the waitForFinish parameter in get, this method can wait indefinitely by polling the build status. It uses the waitForFinish parameter internally (max 60s per call) and continuously polls until the build finishes or the timeout is reached.

  This is useful when you need to immediately start a run after a build finishes.

  ---

  Parameters

  • options: BuildClientWaitForFinishOptions = {}

    Wait options

  Returns Promise<Build>

  The Build object (finished or still building if timeout was reached)

  // Wait indefinitely for build to finish
  const build = await client.build('build-id').waitForFinish();
  console.log(`Build finished with status: ${build.status}`);
  
  // Start a run immediately after build succeeds
  const build = await client.build('build-id').waitForFinish();
  if (build.status === 'SUCCEEDED') {
    const run = await client.actor('my-actor').start();
  }