GET /api/v1/x/write-actions/{id}

X Write

Changed on Oct 20, 2026

Returns the current state of an asynchronous write action.

get/api/v1/x/write-actions/{id}

Request

Base URL: https://xquik.com
URL: https://xquik.com/api/v1/x/write-actions/{id}
Auth: one of:
- API key in header x-api-key
- HTTP bearer

Path parameters

idstring required

Write action ID returned by a pending write response.

Response

Write reached a terminal state.

object'x_write_action' required

idstring required

writeActionIdstring required

terminalboolean required

retryableboolean required

True only when a new attempt is likely to succeed.

safeToRetryboolean required

True only when X did not get the write and a new idempotency key may be used.

statusUrlstring required

pollAfterMsinteger nullable required

chargedboolean required

chargedCreditsstring required

targetIdstring nullable required

requestHashstring

requestIdstring

idempotentboolean

True when this answers a retry of an earlier request with the same Idempotency-Key.

errorstring

messagestring

sendDispatchedboolean required

sendDispatchedAtstring date-time

Dispatch timestamp when the write reached execution.

createdAtstring date-time

updatedAtstring date-time

completedAtstring date-time

expiresAtstring date-time

Deadline for resolving a non-terminal write. This is not the Idempotency-Key retention deadline.

confirmedAtstring date-time

confirmationCheckedAtstring date-time

confirmationAttemptsinteger

tweetIdstring

Compatibility field for a confirmed tweet result ID.

messageIdstring

Compatibility field for a confirmed direct message ID.

mediaIdstring

Compatibility field for a confirmed media upload ID.

mediaUrlstring uri

Public media URL when the upload creates one.

communityIdstring

Compatibility field for a confirmed community ID.

communityNamestring

Confirmed community name when available.

resultIdstring

Compatibility result ID for other write actions.

mediaobject

Media count, kind, size, and billing details when used.

detailsobject

Structured recovery context for a failed write.

successboolean required

Example response

{
  "id": "12345",
  "writeActionId": "12345",
  "action": "like",
  "status": "success",
  "terminal": true,
  "statusUrl": "/api/v1/x/write-actions/12345",
  "pollAfterMs": 1000,
  "charged": true,
  "chargedCredits": "10",
  "billing": {
    "status": "charged",
    "charged": true,
    "plannedCredits": "10",
    "chargedCredits": "10"
  },
  "request": {
    "hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
    "payload": {
      "tweet_id": "9876543210"
    }
  },
  "account": {
    "id": "42",
    "username": "example"
  },
  "target": {
    "type": "tweet",
    "id": "9876543210"
  },
  "targetId": "9876543210",
  "result": {
    "type": "state_change",
    "id": "9876543210",
    "state": "liked"
  },
  "nextAction": {
    "type": "poll",
    "url": "/api/v1/x/write-actions/12345",
    "afterMs": 2000
  },
  "requestHash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "requestId": "01JZ8R7QSC9QKT0V7JX4M2A6B8",
  "error": "x_write_ambiguous",
  "message": "Invalid input. Check request fields.",
  "sendDispatched": true,
  "sendDispatchedAt": "2026-07-21T05:00:00Z",
  "createdAt": "2026-07-21T05:00:00Z",
  "updatedAt": "2026-07-21T05:00:02Z",
  "completedAt": "2026-07-21T05:00:02Z",
  "expiresAt": "2026-07-22T05:00:00Z",
  "confirmedAt": "2026-07-21T05:00:02Z",
  "confirmationCheckedAt": "2026-07-21T05:00:02Z",
  "confirmationAttempts": 1,
  "tweetId": "9876543210",
  "messageId": "1234567890",
  "mediaId": "2345678901",
  "mediaUrl": "https://media.xquik.com/example.jpg",
  "communityId": "3456789012",
  "communityName": "Builders",
  "resultId": "9876543210",
  "media": {
    "count": 1,
    "kind": "image"
  },
  "details": {
    "suggestion": "Poll the action status URL."
  },
  "success": true
}

Changes

Oct 20, 202645942c75fdc2 Revision changes
- warning
  added the new topup_in_progress enum value to the ///// response property for the response status
- warning
  added the new topup_in_progress enum value to the ////// response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status

Operation history