# Get OpenAPI definition


```
GET 
https://api.apify.com/v2/actor-builds/:buildId/openapi.json
```


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

* [First endpoint](https://pr-2390.preview.docs.apify.com/api/v2/act-openapi-json-get.md): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
* [Second endpoint](https://pr-2390.preview.docs.apify.com/api/v2/actor-build-openapi-json-get.md): 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](https://pr-2390.preview.docs.apify.com/api/v2/act-openapi-json-get.md) 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`

### Status 405

Method not allowed.


```
{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}
```


**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 429

Too many requests - rate limit exceeded.


```
{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}
```


**Schema**

* **error** object required

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