Artbrain API

The API endpoints documented here are stable. However, the OpenAPI spec used to generate this documentation is subject to change.

Artbrain provides access to its REST API using the OpenAPI Specification 3 (OAS3).

The base URL for the Artbrain API is https://api.artbrain.co/api/1.0. For private apps, use the format https://<PRIVATE_APP_SUBDOMAIN>.artbrain.co/api/1.0.

To make authenticated requests to the API, an API key must be used in the API-Key header. Please note there is a rate limit of 10 requests per second per API key. Never share your API key and ensure it is stored securely.

• Header Name: API-Key

// Passing API Key token in a Curl shell request
curl --header "API-Key: <YOUR_API_KEY>" https://api.artbrain.co/api/1.0/...

To create an API key (limited to 5 keys per account):

Access API Settings:

• Log in to Artbrain using an account with "Owner" privileges.
• From the avatar menu in the top right corner, select "Auction House Settings."
• In the Auction House Settings, click on the API Keys tab.

Create an API Key:

• Click the "New Key" button.
• In the creation modal, provide a name for the key, then press "OK."

Use the API Key:

• Copy the key using the button under the "Key" column.
• Include this key in the API-Key header for any API call.

The Artbrain API returns status codes consistent with standard HTTP conventions. In addition to the status code, errors may include additional information in the response body:

{
  "message": "additional error information"
}