CoreClaw

CoreClaw API

External open API. Callback Notifications When a run request includes callback_url, this service pushes a POST request to the requester after the run status…

Developer tools#development

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

External open API.

Callback Notifications

When a run request includes callback_url, this service pushes a POST request to the requester after the run status changes or finishes. The callback request body is:

{"run_slug":"run_slug","run_status":"succeeded","error_message":"","execution_start_timestamp":100,"execution_end_timestamp":200,"running_duration":100,"result_count":3,"result_message":"done"}

Error Codes

CodeKeyMessage
10000SYSTEM_ERRORinternal server error
11000INVALID_ARGUMENTinvalid argument
11004NOT_FOUNDnot found
12001UNAUTHORIZEDauthentication required
12002INVALID_TOKENinvalid token
13000RATE_LIMITEDtoo many requests
14000DATABASE_ERRORdatabase error
30001INSUFFICIENT_BALANCEaccount balance is insufficient
50001WORKER_NOT_FOUNDworker does not exist
50002WORKER_RUN_FAILEDworker run failed
50003WORKER_VERSION_UNAVAILABLEthe worker version is not available
60001TASK_NOT_FOUNDtask does not exist
70001RUN_NOT_FOUNDrun record does not exist
70002RUN_FAILEDrun operation failed
16000NOT_IMPLEMENTEDnot implemented

Endpoints 39

proxy

  • GETList proxy regions/api/v2/proxy/region

store

  • GETList store workers/api/v2/store

account

  • GETGet user account/api/v2/users/account

worker-runs

  • GETList worker runs/api/v2/worker-runs
  • GETGet last worker run/api/v2/worker-runs/last
  • POSTAbort last worker run/api/v2/worker-runs/last/abort
  • GETExport last worker run results/api/v2/worker-runs/last/export
  • GETGet last worker run log/api/v2/worker-runs/last/log
  • POSTRerun last worker run/api/v2/worker-runs/last/rerun
  • GETList last worker run results/api/v2/worker-runs/last/result
  • GETGet worker run detail/api/v2/worker-runs/:runId
  • POSTAbort worker run/api/v2/worker-runs/:runId/abort
  • GETGet worker run log/api/v2/worker-runs/:runId/log
  • POSTRerun worker run/api/v2/worker-runs/:runId/rerun
  • GETList worker run results/api/v2/worker-runs/:runId/result
  • GETExport worker run results/api/v2/worker-runs/:runId/result/export
  • GETGet worker last run/api/v2/workers/:workerId/runs/last
  • POSTAbort worker last run/api/v2/workers/:workerId/runs/last/abort
  • GETExport worker last run results/api/v2/workers/:workerId/runs/last/export
  • GETGet worker last run log/api/v2/workers/:workerId/runs/last/log
  • POSTRerun worker last run/api/v2/workers/:workerId/runs/last/rerun
  • GETList worker last run results/api/v2/workers/:workerId/runs/last/result

worker-tasks

  • GETList worker tasks/api/v2/worker-tasks
  • POSTCreate worker task/api/v2/worker-tasks
  • GETGet worker task/api/v2/worker-tasks/:workerTaskId
  • PUTUpdate worker task/api/v2/worker-tasks/:workerTaskId
  • DELETEDelete worker task/api/v2/worker-tasks/:workerTaskId
  • GETGet worker task input/api/v2/worker-tasks/:workerTaskId/input
  • PUTUpdate worker task input/api/v2/worker-tasks/:workerTaskId/input
  • POSTRun worker task/api/v2/worker-tasks/:workerTaskId/runs

workers

  • GETList current user workers/api/v2/workers
  • GETGet worker detail/api/v2/workers/:workerId
  • GETGet worker input schema/api/v2/workers/:workerId/input-schema
  • POSTRun worker/api/v2/workers/:workerId/runs

run-queue

  • GETList run queue items/api/v2/run-queue/items
  • POSTActivate run queue items/api/v2/run-queue/items/activate
  • POSTRelease run queue items/api/v2/run-queue/items/release
  • POSTRelease one run queue item/api/v2/run-queue/items/:queueId/release
  • POSTQueue worker run/api/v2/workers/:workerId/queued-runs

API details

Base URL
https://openapi.coreclaw.com
Authentication
A bearer token in the Authorization header
An API key in the token query parameter
An API key in the api-key header
Operations
39 operations on 35 pathsGET 23POST 13PUT 2DELETE 1
Main resources
worker-runs 19worker-tasks 8run-queue 5workers 4account 1proxy 1store 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 2.0.0

How to test the CoreClaw API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CoreClaw API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List proxy regions” (GET /api/v2/proxy/region), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CoreClaw API?

External open API. Callback Notifications When a run request includes callback_url, this service pushes a POST request to the requester after the run status… It is listed under Developer tools and has 39 endpoints.

Who publishes the CoreClaw API?

It is listed from CoreClaw's public API description (an OpenAPI document), not published by CoreClaw on Swastik Codes. Anyone who controls coreclaw.com can claim the profile by adding a DNS TXT record.

What is the base URL of the CoreClaw API?

Requests go to https://openapi.coreclaw.com. Endpoint paths are added to this base URL.

How do I authenticate with the CoreClaw API?

It accepts 3 methods: A bearer token in the Authorization header; an API key in the token query parameter; an API key in the api-key header.

How many endpoints does the CoreClaw API have?

39 operations on 35 paths (23 GET, 13 POST, 2 PUT, 1 DELETE). The largest groups are worker-runs, worker-tasks, run-queue, workers.

Is forking the CoreClaw API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.