Base URL

The Metal API is available at the following URL


Epigos uses API keys for request authentication. You can access and manage your API keys in the dashboard within the workspace settings.

API Key Headers

TitleHeaderExample Key
API Keyx-api-keyapi_key_1234567890

Example Authenticated Request

curl '' \
--header 'Content-Type: application/json' \
--header 'x-api-key: api_key_1234567890'

or as query parameters

API Key Query

TitleQueryExample Key
API Keyapi-keyapi_key_1234567890

Example Authenticated Request

curl '' \
--header 'Content-Type: application/json'

Retrieve an API Key

You can retrieve an API key from your Epigos AI workspace settings.

First, go to the Epigos AI dashboard. Then, click on Workspace Settings dropdown and click on API Keys:

Response Codes

Epigos uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with Metal’s servers.

200OK - Everything worked as expected.
400Bad Request - Often missing a required parameter.
401Unauthorized - No valid API key provided.
404Not Found - The requested item doesn’t exist.
5xxServer Errors - something went wrong on Metal’s end.