PostliftDevelopers
Documentation menu
Your own Voice

Start paid voice analysis of up to 100 recent posts

Use this endpoint from your own integration, with the same account permissions and safeguards as the app.

Scope · voice:writeIdempotency-Key required10 expensive operations / minute / user

Request

POST/api/v1/voice/{accountId}/refresh
Example requestcURL
curl -X POST 'https://postlift.io/api/v1/voice/{accountId}/refresh' \
  -H "Authorization: Bearer $POSTLIFT_API_KEY" \
  -H 'Idempotency-Key: integration-operation-0001' \
  -H 'Content-Type: application/json' \
  --data '{
  "model": "openai/gpt-6-luna",
  "includeReplies": false
}'

Replace path placeholders with your Postlift resource IDs. Example timestamps must be replaced with a future time; preserve the same timestamp when retrying the same operation.

Parameters

NameLocationDescription
accountIdrequiredpathPostlift resource ID belonging to the API key owner.
Idempotency-KeyrequiredheaderUnique operation key. Reuse only for the same payload/account. See retry semantics in the guide.Pattern: ^[A-Za-z0-9_-]{8,128}$.

Request body

Send JSON with Content-Type: application/json.

FieldType & constraints
modeloptionalstringDefault: "openai/gpt-6-luna".
includeRepliesoptionalbooleanDefault: false.
View JSON schema
{
  "type": "object",
  "properties": {
    "model": {
      "default": "openai/gpt-6-luna",
      "type": "string"
    },
    "includeReplies": {
      "default": false,
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Response

202 Analysis queued; poll the returned job.

FieldType & constraints
jobrequiredVoiceJob ↗
aiRequestsoptionalobject[]
Explore VoiceJobEnvelope ↗
View JSON schema
{
  "type": "object",
  "properties": {
    "job": {
      "$ref": "#/components/schemas/VoiceJob"
    },
    "aiRequests": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "required": [
    "job"
  ],
  "additionalProperties": true
}

Errors & retries

Failures use a stable error code and request ID. Check the current resource version or request status before retrying a write.

StatusMeaning
400Invalid input or Jev rejection
401Invalid, expired or revoked API key
402Plan, publishing quota or AI credit requirement
403Missing scope
404Resource not found or not owned
409Version conflict, missing voice or duplicate AI operation
413Payload too large
429Rate or concurrency limit
500Internal error
502Upstream failure; inspect operation status
503Service or review unavailable
Read the retry guide ↗