> ## 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 context settings

> The account's Context settings in one document: the background SuperX's AI uses when writing for the account. `profile_description` grounds the voice and personalizes the daily content mix and search; `interests` are the highest-priority content topics; `rules` are mandatory instructions on every AI surface; `reply` steers generated replies; `voice.favorite_creators` (max 3) inspire the writing style; `style_guide` holds the manual overrides plus the read-only generated guide; `products` (max 5) are mentioned naturally in generated content.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/context
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: Media
  - name: Scheduling
  - name: Tags
  - name: Context
  - name: Queue
  - name: Articles
  - name: Meta
paths:
  /v1/context:
    get:
      tags:
        - Context
      summary: Get context settings
      description: >-
        The account's Context settings in one document: the background SuperX's
        AI uses when writing for the account. `profile_description` grounds the
        voice and personalizes the daily content mix and search; `interests` are
        the highest-priority content topics; `rules` are mandatory instructions
        on every AI surface; `reply` steers generated replies;
        `voice.favorite_creators` (max 3) inspire the writing style;
        `style_guide` holds the manual overrides plus the read-only generated
        guide; `products` (max 5) are mentioned naturally in generated content.
      operationId: getContext
      parameters:
        - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: The context document.
          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/Context'
              example:
                data:
                  profile_description:
                    text: Indie hacker building SuperX, an X growth platform.
                    enabled: true
                  interests:
                    - indie hacking
                    - SaaS
                    - AI agents
                  rules: Never use hashtags. Keep posts under 200 characters.
                  reply:
                    custom_instructions: Be helpful, never salesy.
                    include_author_name: false
                  voice:
                    favorite_creators:
                      - screen_name: levelsio
                        id: '1577241624'
                        name: Pieter Levels
                        profile_image_url_https: https://pbs.twimg.com/profile_images/example.jpg
                    use_own_posts_as_examples: true
                  style_guide:
                    audience_override: null
                    vocabulary_override: null
                    generated:
                      audience: Bootstrapped SaaS founders and indie hackers.
                      vocabulary: Plain, direct, numbers-first.
                      generated_at: '2026-07-20T09:00:00.000Z'
                  products:
                    - id: 3
                      url: https://superx.so
                      name: SuperX
                      description: X growth platform
                      positioning: null
                      features: null
                      updates: null
                      last_scraped_at: '2026-07-25T12:00:00.000Z'
                      created_at: '2026-07-01T09:00:00.000Z'
                      updated_at: '2026-07-25T12:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/SubscriptionRequired'
        '404':
          $ref: '#/components/responses/AccountNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/UpstreamError'
        '503':
          $ref: '#/components/responses/UpstreamUnavailable'
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
  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:
    Context:
      type: object
      description: >-
        The account's Context settings - the background SuperX's AI uses when
        writing for the account. `style_guide.generated` is read-only.
      properties:
        profile_description:
          type: object
          properties:
            text:
              type: string
            enabled:
              type: boolean
        interests:
          type: array
          items:
            type: string
        rules:
          type: string
          description: Mandatory instructions applied on every AI surface.
        reply:
          type: object
          properties:
            custom_instructions:
              type: string
            include_author_name:
              type: boolean
        voice:
          type: object
          properties:
            favorite_creators:
              type: array
              items:
                $ref: '#/components/schemas/FavoriteCreator'
            use_own_posts_as_examples:
              type: boolean
        style_guide:
          type: object
          properties:
            audience_override:
              type: string
              nullable: true
              description: Manual override; outranks the generated guide until cleared.
            vocabulary_override:
              type: string
              nullable: true
            generated:
              type: object
              description: The app-generated style guide (read-only).
              properties:
                audience:
                  type: string
                  nullable: true
                vocabulary:
                  type: string
                  nullable: true
                generated_at:
                  type: string
                  format: date-time
                  nullable: true
        products:
          type: array
          items:
            $ref: '#/components/schemas/ContextProduct'
    FavoriteCreator:
      type: object
      properties:
        screen_name:
          type: string
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        profile_image_url_https:
          type: string
          nullable: true
    ContextProduct:
      type: object
      properties:
        id:
          type: integer
        url:
          type: string
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        positioning:
          type: string
          nullable: true
        features:
          type: string
          nullable: true
        updates:
          type: string
          nullable: true
        last_scraped_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            When SuperX last refreshed the product's details from its url
            (read-only).
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    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:
    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
    AccountNotFound:
      description: account_id is not one of your accounts.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: account_not_found
              message: No account with that id belongs to this key
    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
    UpstreamError:
      description: A dependent SuperX service returned an unexpected response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: upstream_error
              message: Failed to fetch scheduled posts. Try again shortly.
    UpstreamUnavailable:
      description: >-
        The scheduling service is temporarily unreachable. Safe to retry; reuse
        your Idempotency-Key on POST.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: upstream_unavailable
              message: >-
                The scheduling service is temporarily unavailable. Retry with
                the same Idempotency-Key.
  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.

````