Cancel a Twitter extraction job with the Xquik API

{
  "id": "aB3dE6gH9jK2",
  "status": "canceled"
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "api_key_paused",
  "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "extraction_terminal",
  "message": "Extraction already finished. Check its status.",
  "status": "completed"
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

DELETE

extractions

{id}

Cancel a Twitter extraction job with the Xquik API

curl --request DELETE \
  --url https://xquik.com/api/v1/extractions/{id}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/extractions/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Cancel one extraction job

Send DELETE /extractions/{id} to stop a pending or running job. The job ends as canceled. It saves no rows & uses no credits. A repeat request on a canceled job answers 200, so a retry is safe. Use the job ID from Create Extraction or List Extractions. An API key needs the exports scope for this route.

curl --request DELETE \
  https://xquik.com/api/v1/extractions/aB3dE6gH9jK2 \
  --header "x-api-key: xq_YOUR_KEY_HERE"

const jobId = "aB3dE6gH9jK2";
const response = await fetch(`https://xquik.com/api/v1/extractions/${jobId}`, {
  method: "DELETE",
  headers: { "x-api-key": "xq_YOUR_KEY_HERE" },
});
const body = await response.json();

if (!response.ok) {
  throw new Error(`${response.status} ${body.error}: ${body.message}`);
}

console.log(`${body.id} is ${body.status}`);

import requests

job_id = "aB3dE6gH9jK2"
response = requests.delete(
    f"https://xquik.com/api/v1/extractions/{job_id}",
    headers={"x-api-key": "xq_YOUR_KEY_HERE"},
)
body = response.json()

if not response.ok:
    raise RuntimeError(f'{response.status_code} {body["error"]}: {body["message"]}')

print(f'{body["id"]} is {body["status"]}')

Know when a job can stop

Only a pending or running job can stop. A finished job answers 409 with its status. Its rows stay as they were. To keep the rows a job already found, let it finish. Then read them through Extraction results.

Headers

string

Your Xquik API key. Generate one from the dashboard.

string

An OAuth bearer token formatted as Bearer YOUR_TOKEN. Send this header or x-api-key, not both.

Path parameters

string

required

Extraction job ID returned from Create Extraction or List Extractions.

Response

{ "id": "aB3dE6gH9jK2", "status": "canceled" }

Xquik stopped the job. It saved no rows.

{ "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }

The API key or bearer token is missing or invalid.

{ "error": "insufficient_scope", "message": "This API key lacks the exports scope. Add it at dashboard.xquik.com/api-keys.", "requiredScope": "exports" }

The API key lacks the exports scope, or it is paused.

{ "error": "not_found", "message": "Resource not found." }

No job has this ID, or it belongs to another account.

{ "error": "extraction_terminal", "message": "Extraction already finished. Check its status.", "status": "completed" }

The job already finished. status names how it ended.

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }

Wait for the Retry-After header, then retry once.

Related. Create Extraction starts a new job, and List Extractions shows each job’s status.

{
  "id": "aB3dE6gH9jK2",
  "status": "canceled"
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "api_key_paused",
  "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "extraction_terminal",
  "message": "Extraction already finished. Check its status.",
  "status": "completed"
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

Cancel a Twitter extraction job with the Xquik API

curl --request DELETE \
  --url https://xquik.com/api/v1/extractions/{id}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/extractions/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Overview

X API

X write

Trends

Radar

Account

Activity

API keys

Guest wallets

Credits

X accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

Cancel a Twitter extraction job with the Xquik API

Cancel one extraction job

Know when a job can stop

Headers

Path parameters

Response

​Cancel one extraction job

​Know when a job can stop

​Headers

​Path parameters

​Response

Cancel one extraction job

Know when a job can stop

Headers

Path parameters

Response