Skip to main content
Version: Next

API Access

To access the Executor API, you need to obtain an API key from your account settings. This key will authenticate your requests and allow you to interact with the various endpoints provided by the API. Make sure to keep your API key secure and do not share it publicly.

Authentication​

All API requests must include the API key in the request header. Use the following format:

x-api-key: YOUR_API_KEY

Base URL​

The base URL for all API requests start with /v3/

Create API key​

Go to your profile settings to create a new API key. You will be asked to provide a name and an expiration date for the key. Expired keys will no longer be valid for authentication.

  1. Navigate to API Keys in Profile Settings
  2. Click on Create New API Key
  3. Enter a name for the API key
  4. Set an expiration date
  5. Click Submit

API Key List

Once created, make sure to copy and store the API key securely as it will not be shown again. You can use this key to authenticate your requests to the API.

Error Handling​

The API uses standard HTTP status codes to indicate the success or failure of a request. Common status codes include:

  • 200 OK: The request was successful.
  • 400 Bad Request: The request was invalid or cannot be served.
  • 401 Unauthorized: Authentication failed or user does not have permissions for the requested operation.
  • 403 Forbidden: The request is understood, but it has been refused or access is not allowed.
  • 404 Not Found: The requested resource could not be found.
  • 500 Internal Server Error: An error occurred on the server.

Support​

If you encounter any issues while using the API, please contact our support team at [email protected]

For more detailed information about the API endpoints, request parameters, and response formats, please refer to the Swagger API Documentation