v3

OpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB

Actors/Actor builds

Get OpenAPI definition

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.

To fetch the default Actor build, simply pass default as the buildId. Authentication is based on the build's unique ID. No authentication token is required.

:::note

You can also use the /api/v2/actor-build-openapi-json-get endpoint to get the OpenAPI definition for a build.

:::

get/v2/actors/{actorId}/builds/{buildId}/openapi.json

Path parameters

actorIdstring required

Example:janedoe~my-actor

Actor ID or a tilde-separated owner's username and Actor name.

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.