Skip to main content

REST API

Overview​

A lot of operations that are possible from the platform are also available from the API. To access the API, you need to have an API key.

Request Format​

All requests to the API must be made over HTTPS. All request and response bodies, including errors, are encoded in JSON. All requests must include the Content-Type: application/json header. All responses will include the Content-Type: application/json header.

Authentication​

Authenticate your request with the API key obtained from the settings page of your account. Include your API key in the x-api-key header.

curl -X GET \
  https://dev.arcanelab.ai/api/v1/ \
  -H 'x-api-key: YOUR_API_KEY' \
  ...

API Endpoints​

The API endpoints is available at https://app.swaggerhub.com/apis-docs/ASIF_2/ArcaneLabPublicAPI/1.0.0#/.