Forethought Predictions API

openapi: 3.1.0
info:
  title: Forethought Solve Conversations Predictions API
  description: 'The Forethought Solve API is a headless interface to the Solve generative AI

    customer support agent. Embed Solve into any application by starting a

    conversation with a free-form customer query, then continuing the

    conversation with additional turns or context variables. The metadata

    endpoint returns the workspace''s configured context variables so clients

    can pass the correct values when triggering Autoflows and workflows.


    The Solve API is part of Forethought''s Headless channel and is available on

    the Enterprise plan. SupportGPT, Forethought''s generative AI engine, powers

    response generation, Autoflows, knowledge-base gap detection, and

    article-creation behind the API.

    '
  version: '2025-11-01'
  contact:
    name: Forethought Support
    url: https://support.forethought.ai
  x-logo:
    url: https://forethought.ai/favicon.ico
servers:
- url: https://app.forethought.ai
  description: Production Server
security:
- BearerAuth: []
tags:
- name: Predictions
  description: Predict labels for customer-support tickets.
paths:
  /api/predict:
    post:
      summary: Predict Ticket Triage Labels
      description: 'Submit a ticket subject and body and receive ranked predictions from a

        Forethought Triage model. Each prediction includes a `prediction_value`

        (the label) and `prediction_confidence` (0.0 to 1.0). Use the top

        prediction to route tickets, populate ticket fields, or trigger

        downstream workflows in Zendesk, Salesforce, or other helpdesks.

        '
      operationId: predictTriage
      tags:
      - Predictions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictRequest'
      responses:
        '200':
          description: Predictions returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictResponse'
        '401':
          description: Missing or invalid bearer token.
        '404':
          description: Triage model not found.
        '429':
          description: Request rate limit exceeded.
components:
  schemas:
    Prediction:
      type: object
      properties:
        prediction_value:
          type: string
          description: The predicted label.
        prediction_confidence:
          type: number
          format: float
          minimum: 0
          maximum: 1
    PredictResponse:
      type: object
      properties:
        model_name:
          type: string
        prediction_confidence:
          type: number
          format: float
          minimum: 0
          maximum: 1
        top_predictions:
          type: array
          items:
            $ref: '#/components/schemas/Prediction'
    PredictRequest:
      type: object
      required:
      - model_name
      - text_a
      properties:
        model_name:
          type: string
          description: The Triage model identifier provided by Forethought.
        text_a:
          type: string
          description: Ticket subject or short title.
        text_b:
          type: string
          description: Ticket body or extended description.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Solve API token