Skip to content
Akmelo

Documentation

All API methods

The examples below preserve v1. The same external methods are available under /api/v2 with UUIDs by default; formats and migration.

Choose a method to see its purpose, parameters, request and response examples, plus working curl, server-side Node.js, Go, PHP, and Python clients. Create an API key first and read the server and browser client guide.

Agents

  • List agents · GET /api/v1/agents. Read the status of agents in the current workspace. This does not deploy agents or disclose secrets.
  • Agent status · GET /api/v1/agents/{agent}. Read an existing agent's details, availability, version, and last contact time.

Balance

  • Balance and limits · GET /api/v1/billing. Read the plan, budgets, resource use, and current period for this workspace. This does not add funds.

Sites and data

  • Preview site before creation · POST /api/v1/sites/preview. Read initial information from a URL through a real request to the source.
  • List sites · GET /api/v1/sites. List only sites accessible to the key owner in this workspace.
  • Create site · POST /api/v1/sites. Create a collection source without starting a run.
  • Site details · GET /api/v1/sites/{site}. Read source settings and declared output fields.
  • Update site · PATCH /api/v1/sites/{site}. Change supplied site settings. Saved records are not rebuilt automatically.
  • Delete site · DELETE /api/v1/sites/{site}. Remove a collection source after saving needed results and checking related resources.
  • Fetch site page · POST /api/v1/sites/{site}/fetch. Load one page with the site's network settings. This is a page check, not a full run.
  • Get page snapshot · GET /api/v1/sites/{site}/artifacts/{uuid}. Download a page snapshot or image by UUID after site ownership is checked.
  • Site field schema · GET /api/v1/sites/{site}/fields. Read output fields and dictionaries of allowed types and transformations.
  • Replace field schema · PUT /api/v1/sites/{site}/fields. Save the complete field list; items omitted from the request are removed.
  • Preview field transformation · POST /api/v1/sites/{site}/fields/preview. Apply a chain of transformations to one value without changing saved records.
  • Site records · GET /api/v1/sites/{site}/records. Read saved records with cursor pagination.
  • Record and history · GET /api/v1/sites/{site}/records/{key}. Find a record by stable key and read its change history.

Scenarios

  • List scenarios · GET /api/v1/scripts. List scenarios for accessible sites.
  • Create scenario · POST /api/v1/scripts. Create a scenario entry. Its source code is saved in a separate version.
  • Scenario details · GET /api/v1/scripts/{script}. Read a scenario, its published version, and version history.
  • Update scenario details · PATCH /api/v1/scripts/{script}. Change the scenario name, description, or allowed parameters. Save a new version to change its source.
  • Delete scenario · DELETE /api/v1/scripts/{script}. Remove a collection scenario within the key owner's permissions.
  • Validate source · POST /api/v1/scripts/{script}/validate. Check PHP syntax, functions, and sandbox rules without creating a version.
  • Scenario versions · GET /api/v1/scripts/{script}/versions. List saved versions and their validation results.
  • Save scenario version · POST /api/v1/scripts/{script}/versions. Save source as a draft and return a validation report.
  • Publication history · GET /api/v1/scripts/{script}/publications. Read who changed the active scenario version, when, and why.
  • Publish version · POST /api/v1/scripts/{script}/publish. Make a validated version active for future runs.
  • Roll back version · POST /api/v1/scripts/{script}/rollback. Switch the active publication to a selected earlier version of this scenario.
  • Unpublish scenario · POST /api/v1/scripts/{script}/unpublish. Remove the active version from automatic selection while keeping code and history.

SDK

  • SDK catalog · GET /api/v1/sandbox/sdk. Read the PHP runtime classes, methods, and functions available to the editor and integrations.

Scenario versions

  • Scenario version source · GET /api/v1/script-versions/{version}. Read saved source code, validation result, and publication readiness.
  • Compare scenario versions · GET /api/v1/script-versions/{version}/diff. Compare two versions of the same scenario, or compare against the published version.
  • Branch from version · POST /api/v1/script-versions/{version}/branch. Create an editable draft based on older scenario source.
  • Start trial run · POST /api/v1/script-versions/{version}/trial-run. Queue a version test without writing products to the live catalog.

Runs

  • List runs · GET /api/v1/runs. List runs for accessible sites and their states.
  • Start collection · POST /api/v1/runs. Queue a normal run. The response does not contain the finished result.
  • Run status · GET /api/v1/runs/{run}. Read current status, counts, stages, duration, and user-defined progress.
  • Cancel run · POST /api/v1/runs/{run}/cancel. Request a stop; the worker will finish at the next safe point.
  • Resume run · POST /api/v1/runs/{run}/resume. Continue a completed run from saved state when its state supports resuming.
  • Replay snapshots · POST /api/v1/runs/{run}/replay. Queue a trial replay from saved HTTP responses without reading the source again.
  • Replay report · GET /api/v1/runs/{run}/replay-report. Compare the outcome of a replay with the original run.
  • Run log · GET /api/v1/runs/{run}/log. Read log messages after a given message ID.
  • Run HTTP log · GET /api/v1/runs/{run}/http-log. Read request URLs, HTTP statuses, duration, cache information, and snapshot UUIDs.
  • Record errors · GET /api/v1/runs/{run}/item-errors. Read reasons individual values or records were rejected.
  • Trial run result · GET /api/v1/runs/{run}/preview. Read trial records and field validation results.

Quality

  • Quality vocabulary · GET /api/v1/quality/vocabulary. List allowed rule kinds, actions, and issue severity levels.
  • Quality findings · GET /api/v1/quality/findings. Read issues detected in accessible runs.
  • Quality rules · GET /api/v1/quality/rules. Read rules for accessible sites and platform-wide rules.
  • Create quality rule · POST /api/v1/quality/rules. Add a result check for a specific site.
  • Update quality rule · PATCH /api/v1/quality/rules/{rule}. Change thresholds or the action for a rule on an accessible site.
  • Delete quality rule · DELETE /api/v1/quality/rules/{rule}. Remove a rule for one of your sites. Platform-wide rules cannot be changed with an external key.

Schedules

  • Preview schedule · POST /api/v1/schedules/preview. Validate timing and return upcoming occurrences without saving a schedule.
  • List schedules · GET /api/v1/schedules. List schedules for accessible sites.
  • Create schedule · POST /api/v1/schedules. Configure recurring runs of a published scenario.
  • Schedule details · GET /api/v1/schedules/{schedule}. Read timing rules, pause state, next run, and related scenario.
  • Update schedule · PATCH /api/v1/schedules/{schedule}. Change supplied settings and recalculate the next run.
  • Delete schedule · DELETE /api/v1/schedules/{schedule}. Stop future runs from this schedule. Use pause for a temporary stop.
  • Pause schedule · POST /api/v1/schedules/{schedule}/pause. Disable a schedule indefinitely or until a specified time.
  • Resume schedule · POST /api/v1/schedules/{schedule}/resume. Remove its pause and recalculate future times from now.
  • Run schedule now · POST /api/v1/schedules/{schedule}/run-now. Queue an extra run using the scenario and parameters of a schedule.
  • Schedule events · GET /api/v1/schedules/{schedule}/events. Read scheduler decisions: starts, skips, and rejection reasons.

Exports

  • Export modules · GET /api/v1/exports/modules. List export formats and integrations with their availability status.
  • Suggest export fields · GET /api/v1/exports/{export}/suggest-schema. Generate an initial mapping for the selected module from the source fields. This does not save it.
  • List exports · GET /api/v1/exports. List export profiles for accessible sites.
  • Create export · POST /api/v1/exports. Create a format and field-mapping profile. Prepare the file separately.
  • Export details · GET /api/v1/exports/{export}. Read the field schema, format, processing mode, deliveries, and parameter dictionaries.
  • Update export · PATCH /api/v1/exports/{export}. Save supplied profile settings and validate its schema.
  • Delete export · DELETE /api/v1/exports/{export}. Remove an export profile. Disconnect clients of its endpoint first.
  • Preview export result · GET /api/v1/exports/{export}/preview. Generate a small sample in the export format, including code transformations.
  • Configure code transformation · PUT /api/v1/exports/{export}/transformation. Switch between ordinary mapping and code for record or dataset processing.
  • Prepare export file · POST /api/v1/exports/{export}/run. Build a file from saved records without starting another site collection.
  • File preparation history · GET /api/v1/exports/{export}/runs. Read recent export preparations and links to their files.
  • Export deliveries · GET /api/v1/exports/{export}/deliveries. List the configured ways to send an export result.
  • Create delivery · POST /api/v1/exports/{export}/deliveries. Configure automatic or manual transmission of an export result.
  • Download export file · GET /api/v1/exports/files/{uuid}. Download a prepared file by UUID after the server checks access to its export.

Deliveries

  • Update delivery · PATCH /api/v1/deliveries/{delivery}. Change recipient, write mode, schedule, or other supplied delivery fields.
  • Delete delivery · DELETE /api/v1/deliveries/{delivery}. Remove a saved rule for sending an export result.
  • Run delivery · POST /api/v1/deliveries/{delivery}/run. Queue delivery using an existing rule.
  • Reset delivery cursor · POST /api/v1/deliveries/{delivery}/reset-cursor. Clear the delivered-change marker; the next delivery may repeat the whole dataset.

Connections

  • List connections · GET /api/v1/connections. Read connections in the active workspace without exposing stored passwords.
  • Create connection · POST /api/v1/connections. Save database or S3 settings with an encrypted secret.
  • Probe connection settings · POST /api/v1/connections/probe. Test the specified server without saving a connection.
  • Update connection · PATCH /api/v1/connections/{connection}. Change settings of an accessible database or S3 connection.
  • Delete connection · DELETE /api/v1/connections/{connection}. Remove an unused external database or S3 connection.
  • Test connection · POST /api/v1/connections/{connection}/test. Contact the saved server and check connectivity.
  • List S3 objects · GET /api/v1/connections/{connection}/storage/objects. List files and folders under the storage connection's allowed prefix.
  • Download S3 object · GET /api/v1/connections/{connection}/storage/download. Read the bytes of a file from an accessible storage connection.
  • Search S3 objects · GET /api/v1/connections/{connection}/storage/search. Search the platform's index for objects by key.
  • Preview database structure · GET /api/v1/connections/{connection}/structure/{export}. View proposed SQL statements and current table status for an export.
  • Apply database structure · POST /api/v1/connections/{connection}/structure/{export}. Create the required structure in a recipient database. This modifies an external database.

Proxy pools

  • List proxy pools · GET /api/v1/proxy-pools. List workspace pools and summaries of their addresses.
  • Create proxy pool · POST /api/v1/proxy-pools. Create a group of proxy addresses that sites can use.
  • Update proxy pool · PATCH /api/v1/proxy-pools/{pool}. Change a pool's name, rotation, or active status.
  • Delete proxy pool · DELETE /api/v1/proxy-pools/{pool}. Remove a proxy pool after checking its site assignments.
  • Test proxy pool · POST /api/v1/proxy-pools/{pool}/check. Perform a network check of every address in a pool.
  • Unban proxy pool · POST /api/v1/proxy-pools/{pool}/unban. Clear temporary bans for addresses in a pool.

Proxies

  • List proxies · GET /api/v1/proxies. List addresses in pools belonging to the current workspace.
  • Add proxy · POST /api/v1/proxies. Save an address and optional credentials in your own pool.
  • Import proxies · POST /api/v1/proxies/import. Add multiple addresses and report duplicates or invalid lines.
  • Update proxy · PATCH /api/v1/proxies/{proxy}. Change supplied address fields or move it to another pool you own.
  • Delete proxy · DELETE /api/v1/proxies/{proxy}. Remove a proxy address from its pool.
  • Test proxy · POST /api/v1/proxies/{proxy}/check. Perform a network check of one address.
  • Unban proxy · POST /api/v1/proxies/{proxy}/unban. Lift a temporary ban and clear its failure streak.