API Documentation

Overview

Swiftask is an AI aggregator platform allowing users to access AI functionalities provided by multiple vendors through a unified interface. This document describes how developers can interact with the Swiftask API to send and receive AI-generated responses.

Authentication and Authorization

To ensure secure access to the Swiftask API, authentication and authorization are required for all API requests. Below are the steps to obtain and use an API key, which is necessary for accessing the AI Bot endpoint.

Obtaining an API Key

Create an Account: If you haven't already, you need to sign up for an account at Swiftask.
Generate API Key: Once logged in, navigate to the Developers space section of your account, there, you will find an option to generate a new API key. Click on this option and label your new key for easy identification later.

Record Your API Key: After generation, your API key will be displayed. It is crucial to copy and securely store this key as it will not be visible again. If you lose your API key, you will need to generate a new one.

Base URL

https://graphql.swiftask.ai/api

Endpoint Description

POST /ai/:slug

This endpoint is used to interact with a specific AI identified by a unique slug. It accepts JSON input containing session details and user input, and returns AI-generated responses.

URL Parameter:

slug: Unique string identifier for the AI bot.

HTTP Method: POST

Headers:

Content-Type: application/json
Authorization: Bearer <swiftask_api_key>

Request Body:

{

  "input": "<user_input_message>",
  "files": [
    {
      "url": "<file_url>",
      "type": "<file_type>",
      "size": <file_size>,
      "name": "<file_name>",
      "id": <file_id>
    }
  ],
  "messageHistory": [
    {
      "role": "user|assistant|system",
      "content": "<message_content>",
      "files": [
        {
          "url": "<file_url>",
          "type": "<file_type>",
          "size": <file_size>,
          "name": "<file_name>",
          "id": <file_id>
        }
      ],
      "fromBotSlug": "<bot_slug>"
    }
  ]
}

Response:

{
  "text": "<response_text>",
  "botSlug": "<bot_identifier>",
  "files": [
    {
      "url": "<file_url>",
      "b64_json": "<base64_encoded_json>",
      "type": "<file_type>",
      "size": <file_size>,
      "name": "<file_name>",
      "id": <file_id>
    }
  ],
  "additionalMessages": [
    {
      "text": "<additional_message_text>"
    }
  ],
  "isBotError": <boolean>,
  "sessionId": <session_identifier>,
  "totalBotUsage": <total_usage_count>,
  "usageDetail": {
    "totalInputTokens": <number_of_input_tokens>,
    "totalOutputTokens": <number_of_output_tokens>
  },
  "isSubscriptionUsageLimitReachedMessage": <boolean>,
  "sourceMetadatas": [
    {
      "url": "<source_url>",
      "name": "<source_name>",
      "textChunk": "<text_chunk>",
      "dataSourceId": <data_source_id>,
      "type": "<source_type>",
      "page": "<source_page>"
    }
  ]
}

Sample curl request

curl -X POST 'https://swiftask.com/api/ai/{slug}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <api_key>' \
-d '{
  "input": "Hello, how can I help you today?",
  "files": [],
  "messageHistory": [
    {
      "role": "user",
      "content": "Hello, how can I help you today?"
    }
  ]
}'

Error Handling

Responses from this API will also include standard HTTP status codes to indicate success or failure of the requested operations. Common errors include:

400 Bad Request: Input data is malformed or validation failed.
401 Unauthorized: Missing or invalid authentication token.
404 Not Found: The specified AI slug was not found.
500 Internal Server Error: An error occurred on the server which was not the client's fault.

Usage Guidelines

Ensure the session ID is unique for each session to avoid data conflicts.
Handle file data carefully, especially when dealing with personal or sensitive information.
Monitor your usage to avoid hitting subscription limits unexpectedly.

This API documentation covers the main aspects needed to integrate with various AI bots via Swiftask. For further details or support, contact the Swiftask support team.

Available AI

Below is a table listing each AI name along with its corresponding slug. This reference is crucial when making API requests to interact with different AI functionalities.

PreviousPricing NextFAQ

Last updated 5 days ago

{ "input": "<user_input_message>", "files": [ { "url": "<file_url>", "type": "<file_type>", "size": <file_size>, "name": "<file_name>", "id": <file_id> } ], "messageHistory": [ { "role": "user|assistant|system", "content": "<message_content>", "files": [ { "url": "<file_url>", "type": "<file_type>", "size": <file_size>, "name": "<file_name>", "id": <file_id> } ], "fromBotSlug": "<bot_slug>" } ] }

{ "text": "<response_text>", "botSlug": "<bot_identifier>", "files": [ { "url": "<file_url>", "b64_json": "<base64_encoded_json>", "type": "<file_type>", "size": <file_size>, "name": "<file_name>", "id": <file_id> } ], "additionalMessages": [ { "text": "<additional_message_text>" } ], "isBotError": <boolean>, "sessionId": <session_identifier>, "totalBotUsage": <total_usage_count>, "usageDetail": { "totalInputTokens": <number_of_input_tokens>, "totalOutputTokens": <number_of_output_tokens> }, "isSubscriptionUsageLimitReachedMessage": <boolean>, "sourceMetadatas": [ { "url": "<source_url>", "name": "<source_name>", "textChunk": "<text_chunk>", "dataSourceId": <data_source_id>, "type": "<source_type>", "page": "<source_page>" } ] }

curl -X POST 'https://swiftask.com/api/ai/{slug}' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <api_key>' \ -d '{ "input": "Hello, how can I help you today?", "files": [], "messageHistory": [ { "role": "user", "content": "Hello, how can I help you today?" } ] }'

AI Name

Slug