> ## Documentation Index > Fetch the complete documentation index at: https://docs.superx.so/llms.txt > Use this file to discover all available pages before exploring further. # Get a dataset > One dataset's status, counts and coverage. Every status answers 200, so this is the endpoint to poll while a collection runs: `collecting` carries live `progress`, `failed` carries a `failure_note`, and `ready` carries the honest `coverage` sentence and the `filters` the collection applied. The counts on a collecting dataset are not final. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/datasets/{id} openapi: 3.1.0 info: title: SuperX API version: 1.0.0 description: > The SuperX public API: your Twitter/X content, analytics, audience and scheduling data over REST. All endpoints require an API key (`Authorization: Bearer sxk_...`) except `GET /v1/docs`. Keys are created in the SuperX app under Account > API / MCP / CLI and are server-side secrets. Timestamps are UTC ISO-8601 in both directions; inputs must carry an explicit `Z` or numeric offset. Every authenticated response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers. contact: name: SuperX url: https://superx.so servers: - url: https://api.superx.so security: - apiKey: [] tags: - name: Identity - name: Content - name: Analytics - name: Inspiration - name: Audience - name: Contact Lists - name: Signals - name: Datasets description: | The audience collections Ask SuperX builds in the app: the repliers, quoters or reposters of a post, the members of an X list, your own posts or replies, or a research brief. Collect a new one with `POST /v1/datasets` (a big collection answers 202 and finishes in the background), read it, export it, or copy the people in it into a contact list you created. Datasets are kept for 30 days, and the ones Ask SuperX builds in the app show up here too. - name: Engage description: | The account's saved Engage feeds and the candidate posts in them, for an agent to score and a person to act on. Read-only by design. These endpoints return feed candidates for a person to review; replies are written and sent by a person in the SuperX app, which is why there is no reply endpoint here. Sending spammy, automated, or AI-generated replies that read as inauthentic may get your X account suspended under X's inauthentic-behavior rules and your SuperX account terminated. AI suggestions must be reviewed and meaningfully edited before they are sent, and you are solely responsible for what you post. Reply activity is logged and may be audited. - name: X Lookups description: | Read any public post, its top replies, any public profile, or an account's latest posts LIVE from X, rather than from SuperX's stored data. These are owner-scoped, so none of them take an `account_id`: nothing about a public lookup is per-X-account. They cost the tighter live-enrichment allowance and share a daily allowance of 300 live lookups with Ask SuperX inside the app, so use them for what you actually need rather than to sweep. Repeat lookups within 15 minutes may be served from a short-lived server-side cache. - name: Tools description: | The composer helpers from the SuperX app, over the API: rewrite a post, edit one selected piece of it, apply one preset rewrite, check a claim, or compare two versions. Every one of them returns TEXT and writes nothing. Nothing here is posted, scheduled or sent; save what you keep with `POST /v1/posts/draft` or `POST /v1/scheduled-posts`. They cost AI credits, measured from the models' real cost, and spend no live-data allowance. - name: Media - name: Workers description: | The posts the account's Workers have written, and the three things a person does with one: save it as a draft, schedule it, or dismiss it. A Worker is a scheduled AI writer set up in the SuperX app. Creating, editing and running one stays in the app, so there is no create or run endpoint here. What a run produces lands in the app's "To review" queue and is read with `GET /v1/workers/suggestions`. NOTHING HERE POSTS TO X. Drafting or scheduling a suggestion writes a post the user can see in the app and on `GET /v1/scheduled-posts`, exactly like the app's own buttons. AI output must be reviewed and meaningfully edited by a person before it goes out, so show the text to the user and confirm the time before you schedule anything. - name: Scheduling - name: Tags - name: Context - name: Queue - name: DMs description: | Queue direct messages into the account's own DM pipeline, and read or cancel what is waiting. NOTHING HERE SENDS A MESSAGE. `POST /v1/dm/campaigns` enqueues; the SuperX app's scheduler is what sends, within the account's daily and monthly DM limits, so the create response is counts, not deliveries. Unsent messages can be cancelled until the scheduler picks them up. You are responsible for the messages you queue. Unsolicited or automated bulk DMs may get an X account suspended under X's rules and a SuperX account terminated, so confirm the recipient list and the exact wording with the person on whose behalf you are queueing. - name: Articles - name: Meta paths: /v1/datasets/{id}: get: tags: - Datasets summary: Get a dataset description: | One dataset's status, counts and coverage. Every status answers 200, so this is the endpoint to poll while a collection runs: `collecting` carries live `progress`, `failed` carries a `failure_note`, and `ready` carries the honest `coverage` sentence and the `filters` the collection applied. The counts on a collecting dataset are not final. operationId: getDataset parameters: - $ref: '#/components/parameters/DatasetId' responses: '200': description: The dataset, whatever its status. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/DatasetDetail' example: data: id: VKcPAVU1FSkx4kzPuehGK title: Repliers to my launch post source: repliers status: ready target_ref: '1234567890123456789' x_account_id: '1178367350552305665' ask_chat_id: aB3dEf9 columns: - handle - name - bio - website - followers - following - location - can_dm - verified row_count: 214 scanned_count: 214 total_estimate: 214 coverage_complete: true has_people: true created_at: '2026-09-05T10:12:00.000Z' expires_at: '2026-10-05T10:12:00.000Z' coverage: >- Scanned all 214 direct replies available (relevance-ranked order). filters: minFollowers: 500 '400': $ref: '#/components/responses/InvalidParameter' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/SubscriptionRequired' '404': $ref: '#/components/responses/DatasetNotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: DatasetId: name: id in: path required: true description: The dataset id from `GET /v1/datasets`. schema: type: string pattern: ^[A-Za-z0-9_-]{1,64}$ headers: X-RateLimit-Limit: description: The limit of the rate window closest to exhaustion. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in that window. schema: type: integer X-RateLimit-Reset: description: Unix timestamp (seconds) when that window resets. schema: type: integer schemas: DatasetDetail: allOf: - $ref: '#/components/schemas/Dataset' - type: object properties: coverage: type: string description: An honest one-line coverage statement. Ready datasets only. filters: type: object additionalProperties: true description: The filters the collection applied. Ready datasets only. progress: $ref: '#/components/schemas/DatasetProgress' failure_note: type: string description: Why the collection stopped. Failed datasets only. Dataset: type: object properties: id: type: string description: Pass this to the other dataset endpoints. title: type: string source: type: string enum: - repliers - quoters - reposters - list_members - my_replies - my_posts - research description: >- What the collection walked. `my_posts` / `my_replies` hold posts, everything else holds people. status: type: string enum: - ready - collecting - failed target_ref: type: string description: >- What the collection was pointed at - a post id, an X list id, or free text for a research brief. x_account_id: type: string description: >- The X account the collection ran as. Not a filter - datasets belong to the key owner, not to one account. ask_chat_id: type: string nullable: true description: The Ask SuperX chat the dataset was built in, when known. columns: type: array items: type: string description: The row keys this dataset carries, in export order. row_count: type: integer scanned_count: type: integer description: >- What the walk went through (people datasets), or the rows kept (own-content datasets). total_estimate: type: integer nullable: true coverage_complete: type: boolean description: False when the collection hit its row cap before the end. has_people: type: boolean description: >- False for own-content datasets - there is nobody in them to add to a contact list. created_at: type: string format: date-time expires_at: type: string format: date-time description: Datasets are kept for 30 days. DatasetProgress: type: object description: Live progress of a collection that is still running. properties: page: type: integer scanned: type: integer matched: type: integer total_estimate: type: integer nullable: true started_at: type: string format: date-time ErrorEnvelope: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Stable machine-readable error code. message: type: string retry_after: type: integer description: Seconds to wait before retrying (rate-limit errors only). LegacyErrorEnvelope: type: object required: - error description: | Legacy shape used ONLY by the shared subscription middleware: a plain string `error` field. Seen on `403` when the subscription has lapsed (string starts with "subscription_required:") and on `500` when subscription verification fails (string starts with "internal_error:"). properties: error: type: string example: >- subscription_required: The SuperX API requires an active subscription responses: InvalidParameter: description: A parameter is missing, malformed, or out of range. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_parameter message: since must be a UTC ISO-8601 timestamp Unauthorized: description: >- Missing/malformed Authorization header (`unauthorized`) or an unknown/revoked key (`invalid_api_key`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_api_key message: Unknown or revoked API key SubscriptionRequired: description: | Subscription lapsed. NOTE the legacy body shape: `error` is a plain string here, not the `{ code, message }` object. Read-only keys on write endpoints instead get the object envelope with code `insufficient_scope`. content: application/json: schema: oneOf: - $ref: '#/components/schemas/LegacyErrorEnvelope' - $ref: '#/components/schemas/ErrorEnvelope' example: error: >- subscription_required: The SuperX API requires an active subscription DatasetNotFound: description: No dataset with that id belongs to this key, or it has expired. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: dataset_not_found message: >- No dataset with that id belongs to this key, or it has expired (datasets are kept for 30 days) RateLimited: description: Rate limit exceeded (limits vary by plan). Honor Retry-After. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: rate_limited message: >- Rate limit exceeded for the Pro plan (30 requests/min). Upgrade for higher limits. retry_after: 42 InternalError: description: >- Unexpected server error. May also use the legacy string envelope when subscription verification fails. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/LegacyErrorEnvelope' example: error: code: internal_error message: Failed to fetch posts securitySchemes: apiKey: type: http scheme: bearer description: >- A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets. ````