API Documentation

General Information

Base URL: https://runtldr.com/apis/v1

All API requests must be made over HTTPS.

Summarize Endpoint

Summarize inputted text.

• URL: /summarize
• Method: POST
• Headers:

  Authorization: Bearer YOUR_API_KEY

  Content-Type: application/json

• Body:

              {
                  "responseLength": 1,
                  "responseStyle": "Funny",
                  "inputText": "Lorem ipsum dolor sit amet..."
              }
              

• Input Parameters:

  Parameter	Description	Type
  responseLength	Length of the response summary.	Integer
  responseStyle	Style of the response (e.g., Funny, Serious).	String
  inputText	The text that needs to be summarized.	String

• Response:

              {
                  "status": 200,
                  "input": {
                      "responseLength": 1,
                      "responseStyle": "Funny",
                      "inputText": "Lorem ipsum dolor sit amet..."
                  },
                  "output": {
                      "summary": "Life is short, buy the shoes - ..."
                  }
              }
              

• Output Object:

  Field	Description
  summary	A concise summary of the analysis results, providing an overview of the main findings from the input data. This may include key elements identified, their relationships, and notable features relevant to the image or text being analyzed.

• Response Codes:

  Code	Description
  200	Success - The request was successful, and the response contains the expected output.
  400	Bad Request - The request was invalid or cannot be served.
  401	Unauthorized - Authentication credentials were missing or invalid.
  403	Forbidden - The request was valid, but the server is refusing action.
  404	Not Found - The requested resource could not be found.
  500	Internal Server Error - An error occurred on the server.

Sentiment Analysis Endpoint

Analyze the sentiment of inputted text.

• URL: /sentiment-score
• Method: POST
• Headers:

  Authorization: Bearer YOUR_API_KEY

  Content-Type: application/json

• Body:

  {
      "inputText": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
      "scaleMinimum": 0,
      "scaleMaximum": 1
  }
              

• Input Parameters:

  Parameter	Description	Type
  inputText	The text to be analyzed for sentiment.	String
  scaleMinimum	The minimum value of the sentiment score scale.	Integer
  scaleMaximum	The maximum value of the sentiment score scale.	Integer

• Response:

  {
    "status": 200,
    "input": {
      "scaleMinimum": 0,
      "scaleMaximum": 1,
      "inputText": "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."
    },
    "output": {
      "score": 0.2,
      "label": "negative",
      "confidence": 0.8
    }
  }
              

• Output Object:

  Field	Description
  score	A numerical value representing the overall sentiment score assigned to the input text. This score ranges from the defined scale minimum to maximum, indicating the strength and direction of the sentiment.
  label	A string categorizing the sentiment of the input text, such as "positive," "negative," or "neutral," providing a quick understanding of the emotional tone conveyed.
  confidence	A numerical value indicating the model's confidence in its sentiment classification, ranging from 0 to 1. A higher value reflects greater certainty about the accuracy of the assigned score and label.

• Response Codes:

  Code	Description
  200	Success - The request was successful, and the response contains the expected output.
  400	Bad Request - The request was invalid or cannot be served.
  401	Unauthorized - Authentication credentials were missing or invalid.
  403	Forbidden - The request was valid, but the server is refusing action.
  404	Not Found - The requested resource could not be found.
  500	Internal Server Error - An error occurred on the server.

Text Search Endpoint

Search text for content based on a specific keyword.

• URL: /text-search
• Method: POST
• Headers:

  Authorization: Bearer YOUR_API_KEY

  Content-Type: application/json

• Body:

  {
      "searchType": "person",
      "inputText": "Last weekend, Emily, Jake, and Sarah met up at the local café to discuss their plans for the upcoming community event."
  }
              

• Input Parameters:

  Parameter	Description	Type
  searchType	The type of search being performed (e.g., person).	String
  inputText	The text to be searched for names or keywords.	String

• Response:

  {
      "status": 200,
      "input": {
          "searchType": "person",
          "inputText": "Last weekend, Emily, Jake, and Sarah met up at the local café to discuss their plans for the upcoming community event."
      },
      "output": {
          "results": [ "Emily", "Jake", "Sarah" ]
      }
  }
              

• Output Object:

  Field	Description
  foundResults	A list of identified items from the input text.

• Response Codes:

  Code	Description
  200	Success - The request was successful, and the response contains the expected output.
  400	Bad Request - The request was invalid or cannot be served.
  401	Unauthorized - Authentication credentials were missing or invalid.
  403	Forbidden - The request was valid, but the server is refusing action.
  404	Not Found - The requested resource could not be found.
  500	Internal Server Error - An error occurred on the server.

Image Analysis Endpoint

Analyze the content of inputted images.

• URL: /image-analysis
• Method: POST
• Headers:

  Authorization: Bearer YOUR_API_KEY

  Content-Type: application/json

• Body:

  {
      "url": "https://upload.wikimedia.org/wikipedia/commons/3/37/African_Bush_Elephant.jpg"
  }
              

• Input Parameters:

  Parameter	Description	Type
  imageUrl	The URL of the image to be analyzed.	String

• Response:

  {
      "status": 200,
      "input": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/3/37/African_Bush_Elephant.jpg"
      },
      "output": {
          "foundTags": [
              {
                  "name": "Elephant",
                  "value": 0.98630255
              },
              {
                  "name": "Plant",
                  "value": 0.6193067
              }
          ],
          "description": "African Bush Elephant standing in a savannah landscape. The elephant has large ears, tusks, and a trunk. A young elephant calf is standing close by, with a curious expression. The background features various plants and trees, giving a sense of the elephant's natural habitat."
      }
  }
              

• Output Object:

  Field	Description
  foundTags	A list of identified tags within the image, each containing:
  name	The name of the detected feature or object in the image.
  value	A numerical score indicating the confidence level of the detection, ranging from 0 to 1.
  description	A textual description summarizing the content of the image, including significant elements and their relationships within the scene.

• Response Codes:

  Code	Description
  200	Success - The request was successful, and the response contains the expected output.
  400	Bad Request - The request was invalid or cannot be served.
  401	Unauthorized - Authentication credentials were missing or invalid.
  403	Forbidden - The request was valid, but the server is refusing action.
  404	Not Found - The requested resource could not be found.
  500	Internal Server Error - An error occurred on the server.