API Keys

Check API Key

Check the validity of current use api key

GET/v1/api-keys/check

Header parameters

Response

200400500

Body

application/json

email*string

namestring

Request

JavaScriptCurlPython

const response = await fetch('/v1/api-keys/check', {
    method: 'GET',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "email": "text",
  "name": "text"
}

Create Endpoint Webhook

Add webhook endpoint to an API key

POST/v1/api-keys/webhook/subscribe

Header parameters

Body

application/json

url*string

eventsarray of enum

Default if null: print.failed, print.completed

Response

201400500

Body

application/json

webhookId*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/api-keys/webhook/subscribe', {
    method: 'POST',
    headers: {
      "api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

201

{
  "webhookId": "text"
}

Remove Webhook

Remove webhook endpoint from an API key

DELETE/v1/api-keys/webhook/unsubscribe/{apiWebhookId}

Path parameters

apiWebhookId*string

Header parameters

Response

201400500

Request

JavaScriptCurlPython

const response = await fetch('/v1/api-keys/webhook/unsubscribe/{apiWebhookId}', {
    method: 'DELETE',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();

Get Webhook

Get webhook from its ID

GET/v1/api-keys/webhook/{apiKeyWebhookId}

Path parameters

apiKeyWebhookId*string

Header parameters

Response

201400500

Request

JavaScriptCurlPython

const response = await fetch('/v1/api-keys/webhook/{apiKeyWebhookId}', {
    method: 'GET',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();