Get OpenAPI definition

GET 
/v2/actor-builds/:buildId/openapi.json

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

• First endpoint: Requires both actorId and buildId. Use default as the buildId to get the OpenAPI schema for the default Actor build.
• Second endpoint: 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 /api/v2/act-openapi-json-get endpoint to get the OpenAPI definition for a build.

Request

Path Parameters

buildId string required
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.

Example: soSkq9ekdmfOslopH

Status 200

The OpenAPI specification document for the Actor build.

Response Headers

{}

Schema

• object object

  A standard OpenAPI 3.x JSON document.

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 404

Not found - the requested resource was not found.

{
  "error": {
    "type": "record-not-found",
    "message": "Actor build was not found"
  }
}

Schema

• error object

  • type string

    Possible values: [record-not-found]

  • message string
    Example: Actor build was not found