Request IDs

Every response from the SocialAPI REST API carries an X-Request-ID header, and every error response repeats the same value as request_id in its body. Log it with each call, and include it when you contact support about a failed request.

Read the request ID

curl -i https://api.social-api.ai/v1/accounts \
  -H "Authorization: Bearer $SOCAPI_KEY"

The response headers include:

HTTP 200
X-Request-ID: 9f3c1a7e

SocialAPI generates the ID when you do not send one: 8 lowercase hexadecimal characters, such as 9f3c1a7e. An error response has the ID in the body too:

curl -i https://api.social-api.ai/v1/accounts \
  -H "Authorization: Bearer sapi_key_invalid"

Response (HTTP 401):

{
  "error": {
    "code": "auth.invalid_key",
    "message": "invalid or inactive API key"
  },
  "request_id": "4d82b0c6"
}

The X-Request-ID response header has the value 4d82b0c6, the same as request_id.

Send your own request ID

Send X-Request-ID on the request to use your own correlation ID. SocialAPI echoes your X-Request-ID in the response header and in request_id when it matches ^[a-zA-Z0-9_-]{1,64}$. Otherwise SocialAPI generates an 8-character lowercase hexadecimal ID.

curl -i https://api.social-api.ai/v1/accounts \
  -H "Authorization: Bearer $SOCAPI_KEY" \
  -H "X-Request-ID: order-4821-attempt-2"

Response headers:

HTTP 200
X-Request-ID: order-4821-attempt-2

Rule	Value
Allowed characters	Letters `A-Z` and `a-z`, digits, hyphen, and underscore
Length	1 to 64 characters
When the value does not match	SocialAPI ignores it, returns a generated 8-character ID instead, and does not return an error

SocialAPI does not check that your IDs are unique. Send a different value on each request, or you cannot tell the requests apart when you report one.

Log the request ID in your application

Log the ID of every response, not only of errors, so you can look up any call later:

const resp = await fetch("https://api.social-api.ai/v1/accounts", {
  headers: {
    Authorization: `Bearer ${process.env.SOCAPI_KEY}`,
    "X-Request-ID": myCorrelationId,
  },
});

const requestId = resp.headers.get("X-Request-ID");

if (!resp.ok) {
  const body = await resp.json();
  console.error("SocialAPI error", {
    code: body.error.code,
    message: body.error.message,
    request_id: body.request_id,
  });
} else {
  console.info("SocialAPI call", { request_id: requestId });
}

Report a failed request

Send support the request_id, the HTTP method and path, and the time of the call. The request_id identifies the single request that failed. Two other IDs identify different things:

Delivery ID: X-SocialAPI-Delivery on a webhook your endpoint receives identifies one webhook delivery, not an API request. See Webhooks.
Target errors: a failed post target shows its reason in targets[].error, with no request_id. Report the post ID and the target’s account_id. See Track post delivery.

Errors: the error envelope and every error code
Authentication: auth.* errors for a missing or invalid API key
Rate limits: handle HTTP 429 and Retry-After
Webhooks: X-SocialAPI-Delivery on webhook deliveries
IDs: formats of SocialAPI object IDs

Get started

Connect accounts

Inbox

Automations

Publish

Webhooks

API essentials

Read the request ID

Send your own request ID

Log the request ID in your application

Report a failed request

​Read the request ID

​Send your own request ID

​Log the request ID in your application

​Report a failed request

​Related

Read the request ID

Send your own request ID

Log the request ID in your application

Report a failed request

Related