Segmind · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segmind Inference API

5 actions 5 updates phrasing extends openapi/segmind-inference-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Segmind's API. It is a proposal applied on top of the contract, not a document Segmind publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/{model_name}'].post
$.paths['/v2/{model_name}'].post
$.paths['/v2/requests/{request_id}/status'].get
$.paths['/v2/requests/{request_id}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Segmind Inference API
  version: 1.0.0
extends: openapi/segmind-inference-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/{model_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a model and wait for the output
      effect: write
      questions:
      - How do I call a model like fast-flux-schnell and get the result back in the same response?
      - Which way of calling a model returns the output immediately for jobs under about a minute?
      - Can I generate an image from a text prompt and wait for it synchronously?
      instructions:
      - text: Run {model_name} with the prompt {prompt} and wait for the result.
        slots:
          model_name: path.model_name
          prompt: requestBody.prompt
      - text: Call {model_name} synchronously and return the output directly.
        slots:
          model_name: path.model_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/{model_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a model request to run in the background
      effect: write
      questions:
      - How do I submit a long-running model job and get a request ID to check on later?
      - Can I queue a prompt for a model asynchronously instead of waiting for it to finish?
      instructions:
      - text: Queue an async request to {model_name} with the prompt {prompt} and give me the request ID.
        slots:
          model_name: path.model_name
          prompt: requestBody.prompt
      - text: Submit a background job to {model_name} without waiting for the output.
        slots:
          model_name: path.model_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/requests/{request_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an async request has finished
      effect: read
      questions:
      - Is my queued model request still processing or has it completed?
      - What's a quick way to poll the status of an async request without pulling the full output?
      instructions:
      - text: Check the status of async request {request_id}.
        slots:
          request_id: path.request_id
      - text: Tell me if request {request_id} is done yet.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/requests/{request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full output of an async request
      effect: read
      questions:
      - Where do I fetch the generated output once my async model request completes?
      - Can I retrieve the complete result payload for a background request by its ID?
      instructions:
      - text: Fetch the full result of async request {request_id}.
        slots:
          request_id: path.request_id
      - text: Get me the generated output for request {request_id}.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-10-01'