twexapi-io Sentiment Analysis Endpoints API

openapi: 3.2.0
info:
  title: Twex Sentiment Analysis Endpoints API
  description: 'Public OpenAPI documentation for currently listed TwexAPI public-data endpoints.


    Data handling


    TwexAPI does not maintain an archive or database of X content. We do not persist copies of public posts, X Articles, direct-message content, or AI chat content obtained through customer requests.


    Requests are processed in transit. We retain only limited operational information necessary for security, abuse prevention, billing, and service reliability, such as request timestamps, endpoint usage, status codes, and credit consumption. We do not sell or provide archived X-content datasets.


    Security & BYOC (Bring Your Own Cookie)


    TwexAPI provides stateless automation middleware. For account write actions (posts, DMs, likes), users must authenticate using their own Twitter session credentials. TwexAPI does not provide, sell, or manage third-party accounts.


    User Responsibility: Calling write endpoints requires lawful authorization to operate the target account. The user assumes full responsibility for the compliance and legality of all published content.


    Ephemeral Execution: User-supplied credentials (auth_token and session cookies) exist solely in memory during the transit lifecycle of a single HTTP proxy request and are immediately released upon execution without persistent storage.'
  contact:
    name: TwexAPI Support
    email: support@twexapi.io
    url: https://twexapi.io/contact
  license:
    name: MIT
  version: 1.0.0
  summary: Affordable public social data API with broad endpoint coverage.
  termsOfService: https://twexapi.io/terms
servers:
- url: https://api.twexapi.io
  description: Production API
tags:
- name: Sentiment Analysis Endpoints
paths:
  /twitter/tweets/sentiment:
    post:
      tags:
      - Sentiment Analysis Endpoints
      summary: Sentiment Analysis
      description: Sentiment Analysis, 50 credits per call.
      operationId: sentiment_analysis_endpoint_twitter_tweets_sentiment_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SentimentAnalysisQuery'
        required: true
      responses:
        '200':
          description: A sentiment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SentimentAnalysisResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    SentimentAnalysisResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          $ref: '#/components/schemas/SentimentAnalysisModel'
          description: The sentiment analysis model.
      type: object
      required:
      - code
      - msg
      - data
      title: SentimentAnalysisResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SentimentAnalysisModel:
      properties:
        tone:
          anyOf:
          - type: string
          - type: 'null'
          title: Tone
          description: The tone of the text. Positive, Negative, Neutral, Humorous, Sarcastic, Enthusiastic, Angry, or Informative
        sentiment:
          anyOf:
          - type: string
          - type: 'null'
          title: Sentiment
          description: The sentiment of the text. Positive, Negative, or Neutral
      type: object
      title: SentimentAnalysisModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SentimentAnalysisQuery:
      properties:
        text:
          type: string
          title: Text
          description: The text to analyze.
      type: object
      required:
      - text
      title: SentimentAnalysisQuery
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: TwexAPI developer documentation
  url: https://docs.twexapi.io