Inbox · X Engagement
Searches recent tweets.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the engagement resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string | |
queryrequired | string | Up to 512 characters |
limit | integer | Default 1010 to 100 |
sinceId | string | Matches ^[0-9]{1,19}$ |
untilId | string | Matches ^[0-9]{1,19}$ |
startTime | string (date-time) | |
endTime | string (date-time) | |
cursor | string | |
sortOrder | string | One of recency, relevancyDefault recency |
Example
curl -X GET "https://api.pozy.ai/v1/twitter/search?accountId=696e0b682d0a31188e7a2ba9&query=string&limit=10" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/twitter/search?accountId=696e0b682d0a31188e7a2ba9&query=string&limit=10", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/twitter/search",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
"query": "string",
"limit": 10,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
statusstringtweetsarray of object12 child fields
idstringtextstringcreatedstring (date-time)conversationIdstringinReplyToTweetIdstringCan be null.
langstringauthorobject5 child fields
idstringusernamestringdisplayNamestringavatarstringverifiedTypestring
likeCountintegerreplyCountintegerretweetCountintegerquoteCountintegerplatformstring
paginationobjecthasMorebooleancursorstringCan be null.
metaobjectresultCountintegernewestIdstringCan be null.
oldestIdstringCan be null.
platformstring
200 response
{
"status": "active",
"tweets": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"text": "Hello from Pozy",
"created": "2026-10-02T09:00:00.000Z",
"conversationId": "6e525f3820fc636aa96d2ee9",
"inReplyToTweetId": "60b195e3c6112b0f93ffa7c6",
"lang": "en",
"author": {
"id": "6bfebd43ddc270f6d2c56fc5",
"username": "acme",
"displayName": "Acme",
"avatar": "string",
"verifiedType": "string"
},
"likeCount": 42,
"replyCount": 42,
"retweetCount": 42,
"quoteCount": 42,
"platform": "instagram"
}
],
"pagination": {
"hasMore": true,
"cursor": "string"
},
"meta": {
"resultCount": 42,
"newestId": "62c055044f201f4623743a86",
"oldestId": "60cf7582c9e89859dc6784fd",
"platform": "instagram"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.