APapify
Actor builds

Get OpenAPI definition of Actor build

Changed on

Get the OpenAPI definition for Actor builds. Two similar endpoints are available:

  • Get OpenAPI definition of Actor build (/v2/actors/{actorId}/builds/{buildId}/openapi.json): Requires both actorId and buildId. Use default as the buildId to get the OpenAPI schema for the default Actor build.
  • Get OpenAPI definition of Actor build (/v2/actor-builds/{buildId}/openapi.json): Requires only buildId.

Get the OpenAPI definition for a specific Actor build. Authentication is based on the build's unique ID. No authentication token is required.

:::note

You can also use the Get OpenAPI definition of Actor build endpoint (/v2/actors/{actorId}/builds/{buildId}/openapi.json) to get the OpenAPI definition for a build.

:::

get/v2/actor-builds/{buildId}/openapi.json

Request

  • Base URL
    https://api.apify.com
  • Auth
    none required

Path parameters

buildIdstring required
Example:soSkq9ekdmfOslopH

ID of the build, found in the build's Info tab. Use the special value default to get the OpenAPI schema for the Actor's default build.

Response

The OpenAPI specification document for the Actor build.

object required

A standard OpenAPI 3.x JSON document.

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 16b486b0397aRevision changes
    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status