> ## 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.

# List Worker suggestions

> The posts the account's Workers wrote, newest first. The default
`status=to_review` is the app's "To review" queue: suggestions nobody
has drafted, scheduled or dismissed yet.

Each row carries the text, the Worker that wrote it, the timestamps of
whatever has been done with it, and `post_id` once it was saved as a
post (join it to `GET /v1/scheduled-posts`). `reference` says what kind
of source the Worker wrote from; the Worker's own collection and
reference ids stay private.

Reading changes nothing and spends no AI credits. Act on a row with the
draft, schedule or dismiss endpoints below.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workers/suggestions
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/workers/suggestions:
    get:
      tags:
        - Workers
      summary: List Worker suggestions
      description: |
        The posts the account's Workers wrote, newest first. The default
        `status=to_review` is the app's "To review" queue: suggestions nobody
        has drafted, scheduled or dismissed yet.

        Each row carries the text, the Worker that wrote it, the timestamps of
        whatever has been done with it, and `post_id` once it was saved as a
        post (join it to `GET /v1/scheduled-posts`). `reference` says what kind
        of source the Worker wrote from; the Worker's own collection and
        reference ids stay private.

        Reading changes nothing and spends no AI credits. Act on a row with the
        draft, schedule or dismiss endpoints below.
      operationId: listWorkerSuggestions
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: status
          in: query
          description: >-
            to_review (default) = waiting on a person; drafted, scheduled and
            dismissed = already acted on; all = every suggestion. A dismissed
            suggestion reads as dismissed even if it was saved first.
          schema:
            type: string
            enum:
              - to_review
              - drafted
              - scheduled
              - dismissed
              - all
            default: to_review
        - name: worker_id
          in: query
          description: >-
            Narrow to one Worker by its numeric id (from `GET /v1/workers`). An
            unknown or foreign id returns 404 `worker_not_found`.
          schema:
            type: integer
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: A page of suggestions, generated_at descending.
          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:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkerSuggestion'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
              example:
                data:
                  - id: 4821
                    worker_id: 12
                    text: >-
                      Three things we changed after watching ten people use the
                      onboarding.
                    status: to_review
                    reference:
                      source: collection
                    generated_at: '2026-09-12T08:00:00.000Z'
                    drafted_at: null
                    scheduled_at: null
                    dismissed_at: null
                    post_id: null
                  - id: 4818
                    worker_id: 12
                    text: >-
                      The onboarding rewrite doubled activation. Here is what we
                      cut.
                    status: drafted
                    reference: null
                    generated_at: '2026-09-11T08:00:00.000Z'
                    drafted_at: '2026-09-11T09:14:00.000Z'
                    scheduled_at: null
                    dismissed_at: null
                    post_id: V1StGXR8_Z5jdHi6B-myT
                pagination:
                  page: 1
                  limit: 20
                  has_more: false
                  total: 2
        '400':
          $ref: '#/components/responses/InvalidParameter'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/SubscriptionRequired'
        '404':
          $ref: '#/components/responses/WorkerNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/AccountsUnavailable'
components:
  parameters:
    AccountId:
      name: account_id
      in: query
      required: false
      description: >-
        Account to act on, from `GET /v1/accounts`. Defaults to your main
        account. An id outside your accounts returns `404 account_not_found`.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      required: false
      description: Page size, 1 to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Page:
      name: page
      in: query
      required: false
      description: 1-based page number.
      schema:
        type: integer
        minimum: 1
        default: 1
  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:
    WorkerSuggestion:
      type: object
      description: One post a Worker wrote, waiting for a person to act on it.
      properties:
        id:
          type: integer
          description: Pass this to the draft, schedule and dismiss endpoints.
        worker_id:
          type: integer
          description: The Worker that wrote it; joins to `GET /v1/workers`.
        text:
          type: string
        status:
          type: string
          enum:
            - to_review
            - drafted
            - scheduled
            - dismissed
          description: >-
            A dismissed suggestion reads as dismissed even if it was saved
            first.
        reference:
          type: object
          nullable: true
          description: >-
            What kind of source the Worker wrote from. The collection and
            reference ids stay private.
          properties:
            source:
              type: string
              enum:
                - collection
                - search
              description: >-
                collection = a saved post-format collection, search = a
                high-performing post the run found. Null `reference` means the
                Worker wrote without one.
        generated_at:
          type: string
          format: date-time
          nullable: true
        drafted_at:
          type: string
          format: date-time
          nullable: true
        scheduled_at:
          type: string
          format: date-time
          nullable: true
          description: When it was saved as a scheduled post, not when it goes out.
        dismissed_at:
          type: string
          format: date-time
          nullable: true
        post_id:
          type: string
          nullable: true
          description: >-
            The post it was saved as, once drafted or scheduled. Joins to `GET
            /v1/scheduled-posts`.
    Pagination:
      type: object
      required:
        - page
        - limit
        - has_more
      properties:
        page:
          type: integer
        limit:
          type: integer
        has_more:
          type: boolean
        total:
          type: integer
          description: Present only where cheap to compute.
    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
    WorkerNotFound:
      description: >-
        The worker_id is not one of your Workers (`worker_not_found`), or
        account_id is not one of your accounts (`account_not_found`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: worker_not_found
              message: No worker with that worker_id belongs to this account.
    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
    AccountsUnavailable:
      description: >-
        Linked-account verification is temporarily unavailable (fail closed).
        The main account keeps working.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: accounts_unavailable
              message: >-
                Account information is temporarily unavailable. Try again
                shortly.
  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.

````