---
title: "Get OpenAPI definition"
method: GET
path: "/v2/actors/{actorId}/builds/{buildId}/openapi.json"
tags: ["Actors/Actor builds"]
---

# Get OpenAPI definition

`GET /v2/actors/{actorId}/builds/{buildId}/openapi.json`

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

- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.

- [Second endpoint](/api/v2/actor-build-openapi-json-get): 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`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build.

:::

## Path parameters

- `actorId` string, required
- `buildId` string, required

## Response `200`

The OpenAPI specification document for the Actor build.

- object — A standard OpenAPI 3.x JSON document.

## Other responses

- `400` — Bad request - invalid input parameters or request body.
- `403` — Forbidden - insufficient permissions to perform this action.
- `404` — Not found - the requested resource does not exist.
- `405` — Method not allowed.
- `429` — Too many requests - rate limit exceeded.

## Changes

- **2026-08-28** `0a98d6a098a4` — 5 warning
  - added the new `cannot-publish-actor-task` enum value to the `error/type` response property for the response status `400`
  - added the new `cannot-publish-actor-task` enum value to the `error/type` response property for the response status `403`
  - added the new `cannot-publish-actor-task` enum value to the `error/type` response property for the response status `404`
  - added the new `cannot-publish-actor-task` enum value to the `error/type` response property for the response status `405`
  - …1 more
- **2026-07-31** `5ceb2cdfe616` — 1 info
  - api operation id `act_openapi_json_get` removed and replaced with `actor_openapi_json_get`
- **2026-07-26** `b94a8abdfff1` — 5 warning
  - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `400`
  - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `403`
  - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `404`
  - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `405`
  - …1 more

[Change history](https://skmtc.dev/apify/apis/apify-api/changes/v2/actors/:actorId/builds/:buildId/openapi.json/get.md)

---

[API](https://skmtc.dev/apify/apis/apify-api.md) · [All operations](https://skmtc.dev/apify/apis/apify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apify/apify-api/revisions/0a98d6a098a4/schema)