Text Merchant

https://textmerchant.com/docs
Admin
Text Merchant offers stateless LLM micro-services via REST API for AI tasks such as summarization,...
Tokens:12,197
Snippets:45
Trust Score:2.1
Update:9 months ago
Show doc for...
Tokens:
Raw
### Discovery API

Source: https://textmerchant.com/docs/index

Retrieve schema and examples for AI endpoints to understand their structure and usage.

```APIDOC
## GET /api/summarize/docs/schema

### Description
Get schema and examples for the Summarize endpoint.

### Method
GET

### Endpoint
/api/summarize/docs/schema

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **schema** (object) - The JSON schema for the Summarize endpoint.
- **examples** (object) - Example requests and responses for the Summarize endpoint.

#### Response Example
```json
{
  "schema": { ... },
  "examples": { ... }
}
```

## GET /api/sentiment/docs/schema

### Description
Get schema and examples for the Sentiment endpoint.

### Method
GET

### Endpoint
/api/sentiment/docs/schema

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **schema** (object) - The JSON schema for the Sentiment endpoint.
- **examples** (object) - Example requests and responses for the Sentiment endpoint.

#### Response Example
```json
{
  "schema": { ... },
  "examples": { ... }
}
```

## GET /api/entities/docs/schema

### Description
Get schema and examples for the Entities endpoint.

### Method
GET

### Endpoint
/api/entities/docs/schema

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **schema** (object) - The JSON schema for the Entities endpoint.
- **examples** (object) - Example requests and responses for the Entities endpoint.

#### Response Example
```json
{
  "schema": { ... },
  "examples": { ... }
}
```
```

--------------------------------

### Summarize Text Request Example (JSON)

Source: https://textmerchant.com/docs/summarize

This example demonstrates how to structure a POST request to the /api/summarize endpoint. It includes the text to be summarized and optional parameters for style, focus, and maximum length. The request requires a 'Content-Type' header and a 'PAYMENT-SIGNATURE'.

```json
{
  "text": "Artificial intelligence (AI) is intelligence demonstrated by machines, as opposed to the natural intelligence displayed by humans or animals. Leading AI textbooks define the field as the study of 'intelligent agents': any system that perceives its environment and takes actions that maximize its chance of achieving its goals. Some popular accounts use the term 'artificial intelligence' to describe machines that mimic 'cognitive' functions that humans associate with the human mind, such as 'learning' and 'problem solving'.",
  "options": {
    "style": "bullet",
    "focus": "key-points",
    "maxLength": 100
  }
}
```

--------------------------------

### Summarize Text Response Example (JSON)

Source: https://textmerchant.com/docs/summarize

This example shows a successful response from the /api/summarize endpoint. It contains the generated summary, original and summary lengths, and the applied style and focus. It also includes token usage details for billing and analysis.

```json
{
  "result": {
    "summary": "- AI is machine intelligence as opposed to natural intelligence\n- AI involves 'intelligent agents' that perceive and act to achieve goals\n- AI mimics cognitive functions like learning and problem solving",
    "original_length": 527,
    "summary_length": 168,
    "style": "bullet",
    "focus": "key-points"
  },
  "tokens_used": {
    "prompt_tokens": 156,
    "completion_tokens": 42,
    "total_tokens": 198
  }
}
```

--------------------------------

### Generate Text API Request

Source: https://textmerchant.com/docs/generate

Example of a POST request to the /api/generate endpoint. It includes the text prompt and optional parameters for controlling the generation process, such as maxTokens, temperature, and output format.

```http
POST /api/generate

{
  "text": "Write a brief introduction for a blog post about sustainable gardening.",
  "options": {
    "maxTokens": 150,
    "temperature": 0.8,
    "format": "markdown"
  }
}
```

--------------------------------

### POST /api/qa Request Example

Source: https://textmerchant.com/docs/qa

Demonstrates how to make a POST request to the /api/qa endpoint. It includes the context text and a list of questions to be answered. The 'options' object contains the 'questions' array.

```json
POST /api/qa

{
  "text": "Python is a high-level programming language created by Guido van Rossum...",
  "options": {
    "questions": ["Who created Python?", "When was it released?"]
  }
}
```

--------------------------------

### Generate Text API Response

Source: https://textmerchant.com/docs/generate

Example of a successful response from the /api/generate endpoint. It contains the generated text, prompt and output lengths, format, and token usage details.

```json
{
  "result": {
    "text": "# Embracing Sustainable Gardening\n\nIn an era of environmental awareness...",
    "prompt_length": 98,
    "output_length": 287,
    "format": "markdown"
  },
  "tokens_used": { "prompt_tokens": 67, "completion_tokens": 89, "total_tokens": 156 }
}
```

--------------------------------

### POST /api/qa Response Example

Source: https://textmerchant.com/docs/qa

Illustrates a successful response from the /api/qa endpoint. It contains an array of answers, each with the original question, the extracted answer, and a success status. Also includes token usage and context length.

```json
{
  "result": {
    "answers": [
      { "question": "Who created Python?", "answer": "Guido van Rossum", "success": true },
      { "question": "When was it released?", "answer": "1991", "success": true }
    ],
    "total": 2,
    "successful": 2,
    "context_length": 234
  },
  "tokens_used": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 }
}
```

--------------------------------

### Retrieve Summarize API Schema (curl)

Source: https://textmerchant.com/docs/summarize

This command-line example shows how to fetch the API schema for the text summarization endpoint. This is useful for understanding the request structure and available parameters programmatically.

```bash
curl https://textmerchant.xyz/api/summarize/docs/schema
```

--------------------------------

### Analyze Sentiment Request (JSON)

Source: https://textmerchant.com/docs/sentiment

Example JSON payload for the sentiment analysis API. Includes the text to analyze and optional detailed analysis settings.

```json
{
  "text": "I absolutely love this product! It has exceeded all my expectations and the customer service was outstanding.",
  "options": {
    "detailed": true
  }
}
```

--------------------------------

### Classify Text API Response (JSON)

Source: https://textmerchant.com/docs/classify

Example of a successful response from the /api/classify API. It returns the determined category, a confidence score, an optional explanation for the classification, and a breakdown of tokens used for the request.

```json
{
  "result": {
    "category": "technology",
    "confidence": 0.94,
    "explanation": "Text describes smartphone specifications",
    "all_categories": ["technology", "business", "lifestyle"]
  },
  "tokens_used": { "prompt_tokens": 76, "completion_tokens": 38, "total_tokens": 114 }
}
```

--------------------------------

### Sentiment Analysis Response (JSON)

Source: https://textmerchant.com/docs/sentiment

Example JSON response from the sentiment analysis API. Includes the overall sentiment, confidence score, and detailed emotional indicators if requested.

```json
{
  "result": {
    "sentiment": "positive",
    "confidence": 0.96,
    "score": 0.88,
    "emotional_indicators": ["love", "exceeded", "outstanding"],
    "key_phrases": ["absolutely love", "exceeded expectations", "customer service"]
  },
  "tokens_used": {
    "prompt_tokens": 89,
    "completion_tokens": 45,
    "total_tokens": 134
  }
}
```

--------------------------------

### AI Endpoints

Source: https://textmerchant.com/docs/index

A collection of AI-powered micro-services for various natural language processing tasks. All endpoints require x402 payment verification.

```APIDOC
## POST /api/summarize

### Description
Summarize text with style options (bullet/paragraph/concise).

### Method
POST

### Endpoint
/api/summarize

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to summarize.
- **style** (string) - Optional - The desired summarization style (e.g., 'bullet', 'paragraph', 'concise').

### Request Example
```json
{
  "text": "The quick brown fox jumps over the lazy dog. This is a sample sentence for summarization.",
  "style": "concise"
}
```

### Response
#### Success Response (200)
- **summary** (string) - The summarized text.

#### Response Example
```json
{
  "summary": "A fox jumps over a dog."
}
```

## POST /api/sentiment

### Description
Analyze sentiment and emotion with confidence scores.

### Method
POST

### Endpoint
/api/sentiment

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to analyze.

### Request Example
```json
{
  "text": "I love this product, it's amazing!"
}
```

### Response
#### Success Response (200)
- **sentiment** (string) - The overall sentiment (e.g., 'positive', 'negative', 'neutral').
- **confidence_scores** (object) - Confidence scores for different emotions.

#### Response Example
```json
{
  "sentiment": "positive",
  "confidence_scores": {
    "joy": 0.9,
    "sadness": 0.05,
    "anger": 0.02
  }
}
```

## POST /api/entities

### Description
Extract named entities (PERSON, ORG, GPE, PRODUCT, EVENT, DATE).

### Method
POST

### Endpoint
/api/entities

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to extract entities from.

### Request Example
```json
{
  "text": "Apple announced the new iPhone in Cupertino on September 10th, 2023."
}
```

### Response
#### Success Response (200)
- **entities** (array) - A list of extracted entities.
  - **text** (string) - The extracted entity text.
  - **type** (string) - The type of entity (e.g., 'ORG', 'PERSON', 'DATE').

#### Response Example
```json
{
  "entities": [
    {"text": "Apple", "type": "ORG"},
    {"text": "iPhone", "type": "PRODUCT"},
    {"text": "Cupertino", "type": "GPE"},
    {"text": "September 10th, 2023", "type": "DATE"}
  ]
}
```

## POST /api/keywords

### Description
Extract keywords and key phrases with topic identification.

### Method
POST

### Endpoint
/api/keywords

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to extract keywords from.

### Request Example
```json
{
  "text": "The advancements in artificial intelligence are rapidly changing the technology landscape."
}
```

### Response
#### Success Response (200)
- **keywords** (array) - A list of extracted keywords and key phrases.

#### Response Example
```json
{
  "keywords": ["artificial intelligence", "technology landscape", "advancements"]
}
```

## POST /api/classify

### Description
Classify text into categories (custom categories supported).

### Method
POST

### Endpoint
/api/classify

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to classify.
- **categories** (array) - Optional - A list of custom categories to classify against.

### Request Example
```json
{
  "text": "This is a news article about sports.",
  "categories": ["sports", "technology", "politics"]
}
```

### Response
#### Success Response (200)
- **classification** (string) - The predicted category for the text.

#### Response Example
```json
{
  "classification": "sports"
}
```

## POST /api/question_answering

### Description
Answer questions based on provided context.

### Method
POST

### Endpoint
/api/question_answering

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **question** (string) - Required - The question to answer.
- **context** (string) - Required - The context to find the answer in.

### Request Example
```json
{
  "question": "What is the capital of France?",
  "context": "Paris is the capital and most populous city of France."
}
```

### Response
#### Success Response (200)
- **answer** (string) - The answer to the question.

#### Response Example
```json
{
  "answer": "Paris"
}
```

## POST /api/topics

### Description
Identify main topics and themes in text.

### Method
POST

### Endpoint
/api/topics

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to identify topics from.

### Request Example
```json
{
  "text": "The stock market experienced significant volatility today due to inflation concerns."
}
```

### Response
#### Success Response (200)
- **topics** (array) - A list of identified topics.

#### Response Example
```json
{
  "topics": ["stock market", "inflation", "economy"]
}
```

## POST /api/generate

### Description
Generate text with customizable options (temperature, format).

### Method
POST

### Endpoint
/api/generate

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **prompt** (string) - Required - The prompt to generate text from.
- **temperature** (number) - Optional - Controls randomness (0.0 to 1.0).
- **format** (string) - Optional - Desired output format (e.g., 'text', 'json').

### Request Example
```json
{
  "prompt": "Write a short story about a robot learning to love.",
  "temperature": 0.7,
  "format": "text"
}
```

### Response
#### Success Response (200)
- **generated_text** (string) - The generated text.

#### Response Example
```json
{
  "generated_text": "Unit 734 processed data on human emotions. It found 'love' to be a recurring anomaly..."
}
```

## POST /api/paraphrase

### Description
Paraphrase text with 9 style options and tone variations.

### Method
POST

### Endpoint
/api/paraphrase

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The text to paraphrase.
- **style** (string) - Optional - The desired paraphrasing style (e.g., 'formal', 'casual', 'creative').

### Request Example
```json
{
  "text": "The meeting was postponed due to unforeseen circumstances.",
  "style": "casual"
}
```

### Response
#### Success Response (200)
- **paraphrased_text** (string) - The paraphrased text.

#### Response Example
```json
{
  "paraphrased_text": "We had to push back the meeting because something unexpected came up."
}
```

## POST /api/intent

### Description
Detect user intent from text (custom intents supported).

### Method
POST

### Endpoint
/api/intent

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **text** (string) - Required - The user's text input.
- **intents** (array) - Optional - A list of custom intents to detect.

### Request Example
```json
{
  "text": "I want to book a flight to London.",
  "intents": ["book_flight", "check_weather", "order_food"]
}
```

### Response
#### Success Response (200)
- **detected_intent** (string) - The detected user intent.

#### Response Example
```json
{
  "detected_intent": "book_flight"
}
```
```

--------------------------------

### POST /api/generate

Source: https://textmerchant.com/docs/generate

Generates text based on a provided prompt and customizable options. You can control creativity with temperature, specify the output format, provide custom system prompts, and set the maximum number of tokens for the response.

```APIDOC
## POST /api/generate

### Description
Generate text based on a prompt with fine-grained control. Adjust temperature for creativity, set output format, provide custom system prompts, and control generation length.

### Method
POST

### Endpoint
/api/generate

### Parameters
#### Request Body
- **text** (string) - Required - The prompt to generate text from.
- **options** (object) - Optional - Configuration for text generation.
  - **maxTokens** (integer) - Optional - Response length (50-2000). Defaults to 150.
  - **temperature** (float) - Optional - Controls creativity (0=focused, 1=balanced, 2=creative). Defaults to 0.8.
  - **format** (string) - Optional - Output format (plain, markdown, html). Defaults to markdown.
  - **systemPrompt** (string) - Optional - Custom AI behavior instructions.

### Request Example
```json
{
  "text": "Write a brief introduction for a blog post about sustainable gardening.",
  "options": {
    "maxTokens": 150,
    "temperature": 0.8,
    "format": "markdown"
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - The generated text and related information.
  - **text** (string) - The generated text content.
  - **prompt_length** (integer) - The number of tokens in the prompt.
  - **output_length** (integer) - The number of tokens in the generated output.
  - **format** (string) - The format of the generated text.
- **tokens_used** (object) - Information about token usage.
  - **prompt_tokens** (integer) - Tokens used for the prompt.
  - **completion_tokens** (integer) - Tokens used for the completion.
  - **total_tokens** (integer) - Total tokens used for the request.

#### Response Example
```json
{
  "result": {
    "text": "# Embracing Sustainable Gardening\n\nIn an era of environmental awareness...",
    "prompt_length": 98,
    "output_length": 287,
    "format": "markdown"
  },
  "tokens_used": { "prompt_tokens": 67, "completion_tokens": 89, "total_tokens": 156 }
}
```
```

--------------------------------

### Support Endpoints

Source: https://textmerchant.com/docs/index

Utility endpoints for checking service health and payment-related information.

```APIDOC
## GET /payment/supported

### Description
List all supported payment chains and tokens.

### Method
GET

### Endpoint
/payment/supported

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **supported_chains** (object) - An object detailing supported chains and their tokens.

#### Response Example
```json
{
  "supported_chains": {
    "Base Mainnet": ["USDC"],
    "SKALE Base Chain": ["USDC", "USDT", "WETH", "WBTC"]
  }
}
```

## GET /payment/quote/:chain

### Description
Get a payment quote for a specific payment chain.

### Method
GET

### Endpoint
/payment/quote/:chain

### Parameters
#### Path Parameters
- **chain** (string) - Required - The name of the payment chain (e.g., 'Base Mainnet').

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **quote** (object) - Payment quote details.

#### Response Example
```json
{
  "quote": {
    "chain": "Base Mainnet",
    "token": "USDC",
    "amount": "0.01",
    "currency": "USD"
  }
}
```

## GET /healthz

### Description
Check the health status of the service.

### Method
GET

### Endpoint
/healthz

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - The health status of the service (e.g., 'ok').

#### Response Example
```json
{
  "status": "ok"
}
```
```

--------------------------------

### POST /api/topics

Source: https://textmerchant.com/docs/topics

Extracts the main topics and themes from a given text. It returns topic labels, descriptions, relevance scores, and optionally, associated keywords.

```APIDOC
## POST /api/topics

### Description
Discover the main topics and themes in text. Returns topic labels, descriptions, relevance scores, and optional keywords.

### Method
POST

### Endpoint
/api/topics

### Parameters
#### Request Body
- **text** (string) - Required - The input text to analyze.
- **options** (object) - Optional - Configuration options for topic extraction.
  - **numTopics** (integer) - Optional - The desired number of topics to return. Defaults to a system-determined value.
  - **includeKeywords** (boolean) - Optional - Whether to include keywords for each topic. Defaults to false.

### Request Example
```json
{
  "text": "The article discusses remote work productivity, mental health, and team collaboration...",
  "options": {
    "numTopics": 3,
    "includeKeywords": true
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - Contains the extracted topics and analysis details.
  - **topics** (array) - A list of identified topics.
    - **label** (string) - The name of the topic.
    - **description** (string) - A brief description of the topic.
    - **keywords** (array of strings) - Optional. Keywords associated with the topic if `includeKeywords` was true.
    - **relevance** (number) - The relevance score of the topic to the text (0.0 to 1.0).
  - **dominant_topic** (string) - The most prominent topic in the text.
  - **text_length** (integer) - The length of the input text in characters.
- **tokens_used** (object) - Information about token consumption for the request.
  - **prompt_tokens** (integer) - The number of tokens used in the prompt.
  - **completion_tokens** (integer) - The number of tokens used in the completion.
  - **total_tokens** (integer) - The total number of tokens used for the request.

#### Response Example
```json
{
  "result": {
    "topics": [
      {
        "label": "Remote Work Productivity",
        "description": "Analysis of how working from home affects output",
        "keywords": ["productivity", "efficiency", "performance"],
        "relevance": 0.95
      }
    ],
    "dominant_topic": "Remote Work Productivity",
    "text_length": 256
  },
  "tokens_used": { "prompt_tokens": 134, "completion_tokens": 156, "total_tokens": 290 }
}
```
```

--------------------------------

### POST /api/paraphrase

Source: https://textmerchant.com/docs/paraphrase

Rewrite text in different styles while preserving meaning. Choose from 9 styles, adjust tone and length, and generate multiple variations.

```APIDOC
## POST /api/paraphrase

### Description
Rewrite text in different styles while preserving meaning. Choose from 9 styles, adjust tone and length, and generate multiple variations.

### Method
POST

### Endpoint
/api/paraphrase

### Parameters
#### Request Body
- **text** (string) - Required - The text to be paraphrased.
- **options** (object) - Optional - Configuration for paraphrasing.
  - **style** (string) - Optional - The desired style for paraphrasing (e.g., "professional", "casual"). Defaults to "professional".
  - **tone** (string) - Optional - The desired tone for paraphrasing (e.g., "neutral", "formal"). Defaults to "neutral".
  - **variations** (integer) - Optional - The number of paraphrased variations to generate. Defaults to 1.

### Request Example
```json
{
  "text": "The meeting has been rescheduled to next Tuesday at 3pm.",
  "options": {
    "style": "professional",
    "tone": "neutral",
    "variations": 2
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - Contains the paraphrased results.
  - **paraphrases** (array of strings) - A list of generated paraphrased texts.
  - **original** (string) - The original text provided.
  - **style** (string) - The style used for paraphrasing.
  - **tone** (string) - The tone used for paraphrasing.
  - **count** (integer) - The number of variations generated.
- **tokens_used** (object) - Information about token usage.
  - **prompt_tokens** (integer) - Number of tokens used in the prompt.
  - **completion_tokens** (integer) - Number of tokens used in the completion.
  - **total_tokens** (integer) - Total number of tokens used.

#### Response Example
```json
{
  "result": {
    "paraphrases": [
      "Please be advised that the meeting has been moved to next Tuesday at 3:00 PM.",
      "Kindly note the rescheduling of our meeting to Tuesday at 3 PM next week."
    ],
    "original": "The meeting has been rescheduled to next Tuesday at 3pm.",
    "style": "professional",
    "tone": "neutral",
    "count": 2
  },
  "tokens_used": { "prompt_tokens": 72, "completion_tokens": 58, "total_tokens": 130 }
}
```

### Available Styles
formal, casual, professional, simple, creative, academic, persuasive, friendly, technical
```

--------------------------------

### Extract Topics using POST /api/topics

Source: https://textmerchant.com/docs/topics

This snippet demonstrates how to send a POST request to the /api/topics endpoint to extract topics from a given text. It includes sample request payload with text and options like the number of topics and keyword inclusion, and a corresponding response structure.

```json
POST /api/topics

{
  "text": "The article discusses remote work productivity, mental health, and team collaboration...",
  "options": {
    "numTopics": 3,
    "includeKeywords": true
  }
}
```

```json
{
  "result": {
    "topics": [
      {
        "label": "Remote Work Productivity",
        "description": "Analysis of how working from home affects output",
        "keywords": ["productivity", "efficiency", "performance"],
        "relevance": 0.95
      }
    ],
    "dominant_topic": "Remote Work Productivity",
    "text_length": 256
  },
  "tokens_used": { "prompt_tokens": 134, "completion_tokens": 156, "total_tokens": 290 }
}
```

--------------------------------

### POST /api/summarize

Source: https://textmerchant.com/docs/summarize

Summarize long text into concise, focused summaries. Choose from different styles (bullet points, paragraph, or ultra-concise) and focus areas (key points, executive summary, or technical details).

```APIDOC
## POST /api/summarize

### Description
Summarize long text into concise, focused summaries. Choose from different styles (bullet points, paragraph, or ultra-concise) and focus areas (key points, executive summary, or technical details).

### Method
POST

### Endpoint
/api/summarize

### Parameters
#### Query Parameters
- **text** (string) - Required - Text to summarize (1-10,000 characters)
- **options.style** (enum) - Optional - `bullet`, `paragraph`, `concise`
- **options.focus** (enum) - Optional - `key-points`, `executive`, `technical`
- **options.maxLength** (number) - Optional - Maximum summary length (50-500 words)

### Request Example
```json
{
  "text": "Artificial intelligence (AI) is intelligence demonstrated by machines, as opposed to the natural intelligence displayed by humans or animals. Leading AI textbooks define the field as the study of 'intelligent agents': any system that perceives its environment and takes actions that maximize its chance of achieving its goals. Some popular accounts use the term 'artificial intelligence' to describe machines that mimic 'cognitive' functions that humans associate with the human mind, such as 'learning' and 'problem solving'.",
  "options": {
    "style": "bullet",
    "focus": "key-points",
    "maxLength": 100
  }
}
```

### Response
#### Success Response (200)
- **result.summary** (string) - The summarized text.
- **result.original_length** (number) - The character length of the original text.
- **result.summary_length** (number) - The character length of the summarized text.
- **result.style** (string) - The style used for the summary.
- **result.focus** (string) - The focus used for the summary.
- **tokens_used.prompt_tokens** (number) - The number of tokens used for the prompt.
- **tokens_used.completion_tokens** (number) - The number of tokens used for the completion.
- **tokens_used.total_tokens** (number) - The total number of tokens used.

#### Response Example
```json
{
  "result": {
    "summary": "- AI is machine intelligence as opposed to natural intelligence\n- AI involves 'intelligent agents' that perceive and act to achieve goals\n- AI mimics cognitive functions like learning and problem solving",
    "original_length": 527,
    "summary_length": 168,
    "style": "bullet",
    "focus": "key-points"
  },
  "tokens_used": {
    "prompt_tokens": 156,
    "completion_tokens": 42,
    "total_tokens": 198
  }
}
```

### Error Handling
- **400 Bad Request**: Validation failed or content blocked by security checks.
- **402 Payment Required**: Invalid or missing x402 payment headers.
- **451 Unavailable**: Generated content filtered by security checks.

### Notes
- Text length must be between 1 and 10,000 characters.
- Maximum summary length can be set between 50-500 words.
- Default style is `bullet`.
- Default focus is `key-points`.
- Executive focus emphasizes business impact and actionable insights.
- Technical focus preserves implementation details and technical considerations.
```

--------------------------------

### POST /api/qa

Source: https://textmerchant.com/docs/qa

Answer questions based on provided context. The AI extracts answers ONLY from the given context - no external knowledge is used. Supports single or multiple questions.

```APIDOC
## POST /api/qa

### Description
Answer questions based on provided context. The AI extracts answers ONLY from the given context - no external knowledge is used. Supports single or multiple questions.

### Method
POST

### Endpoint
/api/qa

### Parameters
#### Request Body
- **text** (string) - Required - The context text from which to extract answers.
- **options** (object) - Required - An object containing question-related options.
  - **questions** (array of strings) - Required - A list of questions to answer based on the provided text.

### Request Example
```json
{
  "text": "Python is a high-level programming language created by Guido van Rossum...",
  "options": {
    "questions": ["Who created Python?", "When was it released?"]
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - Contains the answers and related statistics.
  - **answers** (array of objects) - A list of answers, each with the original question, the extracted answer, and a success status.
    - **question** (string) - The question asked.
    - **answer** (string) - The extracted answer from the context.
    - **success** (boolean) - Indicates if an answer was successfully found and extracted.
  - **total** (integer) - The total number of questions asked.
  - **successful** (integer) - The number of questions successfully answered.
  - **context_length** (integer) - The length of the provided context text.
- **tokens_used** (object) - Information about token usage for the request.
  - **prompt_tokens** (integer) - Tokens used in the prompt.
  - **completion_tokens** (integer) - Tokens used in the completion.
  - **total_tokens** (integer) - Total tokens used for the request.

#### Response Example
```json
{
  "result": {
    "answers": [
      { "question": "Who created Python?", "answer": "Guido van Rossum", "success": true },
      { "question": "When was it released?", "answer": "1991", "success": true }
    ],
    "total": 2,
    "successful": 2,
    "context_length": 234
  },
  "tokens_used": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 }
}
```

### IMPORTANT
- Context text can be up to 50,000 characters.
- Either `question` or `questions` must be provided in the options.
- Answers come ONLY from the provided context.
- If an answer is not in the context, the response will indicate this with `success: false` for that specific question.
```

--------------------------------

### Paraphrase Text API Request (JSON)

Source: https://textmerchant.com/docs/paraphrase

This snippet demonstrates how to send a POST request to the /api/paraphrase endpoint. It includes the text to be paraphrased and optional parameters for style, tone, and the number of variations. The request body is formatted in JSON.

```json
{
  "text": "The meeting has been rescheduled to next Tuesday at 3pm.",
  "options": {
    "style": "professional",
    "tone": "neutral",
    "variations": 2
  }
}
```

--------------------------------

### POST /api/intent

Source: https://textmerchant.com/docs/intent

Identify user intent from text for conversational AI and chatbots. Supports 15 default intents plus custom intents.

```APIDOC
## POST /api/intent

### Description
Identify user intent from text for conversational AI and chatbots. Supports 15 default intents plus custom intents.

### Method
POST

### Endpoint
/api/intent

### Parameters
#### Request Body
- **text** (string) - Required - The input text to analyze for intent.
- **options** (object) - Optional - Configuration options for the intent detection.
  - **includeConfidence** (boolean) - Optional - Whether to include confidence scores in the response.
  - **includeEntities** (boolean) - Optional - Whether to include identified entities in the response.

### Request Example
```json
{
  "text": "I need to cancel my subscription and get a refund for this month.",
  "options": {
    "includeConfidence": true,
    "includeEntities": true
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - The detected intent and related information.
  - **intent** (string) - The identified user intent.
  - **confidence** (number) - The confidence score for the detected intent (if requested).
  - **reasoning** (string) - An explanation for the detected intent.
  - **entities** (array of strings) - Entities identified in the text (if requested).
  - **supported_intents** (array of strings) - A list of all supported intents.
- **tokens_used** (object) - Information about token usage for the request.
  - **prompt_tokens** (integer) - Number of tokens used in the prompt.
  - **completion_tokens** (integer) - Number of tokens used in the completion.
  - **total_tokens** (integer) - Total tokens used for the request.

#### Response Example
```json
{
  "result": {
    "intent": "cancellation",
    "confidence": 0.92,
    "reasoning": "User explicitly states they want to 'cancel' and mentions 'refund'",
    "entities": ["subscription", "month", "refund"],
    "supported_intents": ["question", "complaint", "request", "booking", "inquiry", "feedback", "support", "purchase", "cancellation", "information", "greeting", "goodbye", "confirmation", "refusal", "other"]
  },
  "tokens_used": { "prompt_tokens": 98, "completion_tokens": 67, "total_tokens": 165 }
}
```
```

--------------------------------

### Detect Intent API Request (JSON)

Source: https://textmerchant.com/docs/intent

This snippet demonstrates how to make a POST request to the /api/intent endpoint to detect user intent. It includes the text to analyze and optional parameters for including confidence scores and entities.

```json
POST /api/intent

{
  "text": "I need to cancel my subscription and get a refund for this month.",
  "options": {
    "includeConfidence": true,
    "includeEntities": true
  }
}
```

--------------------------------

### Classify Text API Request (JSON)

Source: https://textmerchant.com/docs/classify

Demonstrates how to send a POST request to the /api/classify endpoint to categorize text. It includes the text to be classified and optional parameters like custom categories and a request for an explanation. The response includes the classified category, confidence score, and an explanation.

```json
POST /api/classify

{
  "text": "The latest smartphone features a 6.7-inch OLED display, 5G connectivity...",
  "options": {
    "categories": ["technology", "business", "lifestyle"],
    "explanation": true
  }
}
```

--------------------------------

### Extract Keywords from Text (API Request)

Source: https://textmerchant.com/docs/keywords

This snippet demonstrates how to make a POST request to the /api/keywords endpoint to extract keywords, key phrases, and topics from a given text. It includes the request body with the text and optional parameters like limit and includePhrases.

```http
POST /api/keywords

{
  "text": "Machine learning is a subset of artificial intelligence that focuses on algorithms...",
  "options": {
    "limit": 8,
    "includePhrases": true
  }
}
```

--------------------------------

### POST /api/keywords

Source: https://textmerchant.com/docs/keywords

Extracts important keywords, key phrases, and topics from provided text. This is useful for tagging, indexing, and content discovery.

```APIDOC
## POST /api/keywords

### Description
Extract important keywords, key phrases, and topics from text. Useful for tagging, indexing, and content discovery.

### Method
POST

### Endpoint
/api/keywords

### Parameters
#### Request Body
- **text** (string) - Required - The input text from which to extract keywords.
- **options** (object) - Optional - Configuration options for keyword extraction.
  - **limit** (integer) - Optional - The maximum number of keywords to return.
  - **includePhrases** (boolean) - Optional - Whether to include key phrases in the response.
```

```APIDOC
### Request Example
```json
{
  "text": "Machine learning is a subset of artificial intelligence that focuses on algorithms...",
  "options": {
    "limit": 8,
    "includePhrases": true
  }
}
```
```

```APIDOC
### Response
#### Success Response (200)
- **result** (object) - Contains the extracted keywords, key phrases, and topics.
  - **keywords** (array of strings) - A list of extracted keywords.
  - **key_phrases** (array of strings) - A list of extracted key phrases.
  - **topics** (array of strings) - A list of identified topics.
- **tokens_used** (object) - Information about token usage for the request.
  - **prompt_tokens** (integer) - The number of tokens used for the prompt.
  - **completion_tokens** (integer) - The number of tokens used for the completion.
  - **total_tokens** (integer) - The total number of tokens used.
```

```APIDOC
#### Response Example
```json
{
  "result": {
    "keywords": ["machine learning", "algorithms", "data", "AI", "artificial intelligence"],
    "key_phrases": ["subset of artificial intelligence", "learn from data"],
    "topics": ["Machine Learning", "Artificial Intelligence", "Computer Science"]
  },
  "tokens_used": { "prompt_tokens": 98, "completion_tokens": 52, "total_tokens": 150 }
}
```
```

--------------------------------

### Extract Entities using POST /api/entities

Source: https://textmerchant.com/docs/entities

This snippet demonstrates how to use the POST /api/entities endpoint to extract named entities from a text. It shows the request payload with the text and optional parameters for entity types and confidence inclusion, as well as the expected JSON response containing the extracted entities and their details.

```json
POST /api/entities

{
  "text": "Apple Inc. was founded by Steve Jobs in Cupertino, California in April 1976.",
  "options": {
    "types": ["PERSON", "ORG", "GPE", "DATE"],
    "includeConfidence": true
  }
}
```

```json
{
  "result": {
    "entities": [
      { "text": "Apple Inc.", "type": "ORG", "start": 0, "end": 10, "confidence": 0.98 },
      { "text": "Steve Jobs", "type": "PERSON", "start": 24, "end": 34, "confidence": 0.99 },
      { "text": "Cupertino", "type": "GPE", "start": 38, "end": 47, "confidence": 0.97 }
    ],
    "count": 5,
    "types_found": ["ORG", "PERSON", "GPE", "DATE"]
  },
  "tokens_used": { "prompt_tokens": 112, "completion_tokens": 78, "total_tokens": 190 }
}
```

--------------------------------

### Fetch Sentiment Analysis Schema (curl)

Source: https://textmerchant.com/docs/sentiment

Command to retrieve the API schema for sentiment analysis using curl. This helps in understanding the expected request and response formats.

```bash
curl https://textmerchant.xyz/api/sentiment/docs/schema
```

--------------------------------

### Paraphrase Text API Response (JSON)

Source: https://textmerchant.com/docs/paraphrase

This snippet shows a typical JSON response from the /api/paraphrase endpoint after a successful paraphrasing request. It includes the generated paraphrases, the original text, the applied style and tone, and token usage details.

```json
{
  "result": {
    "paraphrases": [
      "Please be advised that the meeting has been moved to next Tuesday at 3:00 PM.",
      "Kindly note the rescheduling of our meeting to Tuesday at 3 PM next week."
    ],
    "original": "The meeting has been rescheduled to next Tuesday at 3pm.",
    "style": "professional",
    "tone": "neutral",
    "count": 2
  },
  "tokens_used": { "prompt_tokens": 72, "completion_tokens": 58, "total_tokens": 130 }
}
```

--------------------------------

### Detect Intent API Response (JSON)

Source: https://textmerchant.com/docs/intent

This snippet shows a typical JSON response from the /api/intent endpoint. It includes the detected intent, confidence score, reasoning, extracted entities, and a list of supported intents, along with token usage information.

```json
{
  "result": {
    "intent": "cancellation",
    "confidence": 0.92,
    "reasoning": "User explicitly states they want to 'cancel' and mentions 'refund'",
    "entities": ["subscription", "month", "refund"],
    "supported_intents": ["question", "complaint", "request", "booking", "inquiry", "feedback", "support", "purchase", "cancellation", "information", "greeting", "goodbye", "confirmation", "refusal", "other"]
  },
  "tokens_used": { "prompt_tokens": 98, "completion_tokens": 67, "total_tokens": 165 }
}
```

--------------------------------

### Keyword Extraction API Response Structure

Source: https://textmerchant.com/docs/keywords

This snippet shows the expected JSON response structure after successfully calling the /api/keywords endpoint. It details the 'result' object containing keywords, key phrases, and topics, along with 'tokens_used' information.

```json
{
  "result": {
    "keywords": ["machine learning", "algorithms", "data", "AI", "artificial intelligence"],
    "key_phrases": ["subset of artificial intelligence", "learn from data"],
    "topics": ["Machine Learning", "Artificial Intelligence", "Computer Science"]
  },
  "tokens_used": { "prompt_tokens": 98, "completion_tokens": 52, "total_tokens": 150 }
}
```
Tokens:
Raw