TaskingAI

https://docs.tasking.ai/
Admin
TaskingAI is an AI-native application development platform that unifies modules like Model,...
Tokens:84,927
Snippets:892
Trust Score:6.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install taskingai Package

Source: https://docs.tasking.ai/docs/guide/sdks/python/quickstart

Use pip to install the taskingai Python package. This is the first step to begin using the SDK.

```bash
pip install taskingai  
```

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

### Configure Environment Variables

Source: https://docs.tasking.ai/docs/guide/self-hosting-with-docker

Prepare the environment configuration file from the provided example.

```bash
cp .env.example .env  
```

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

### Install TaskingAI Package

Source: https://docs.tasking.ai/docs/developer-guide/python-sdk/quickstart

Use pip to install the taskingai library in your Python environment.

```bash
pip install taskingai
```

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

### Run Service from Source

Source: https://docs.tasking.ai/docs/taskingai-inference/Installation-and-Setup

Start the application using the local Python environment.

```bash
PYTHONPATH=$(pwd) python app/main.py  
```

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

### QA Record Creation Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/knowledge/create-a-record

This is an example of a successful response after creating a QA record. The record status will initially be 'creating' and will change to 'ready' once the Q&A chunks are processed.

```json
{
  "status": "success",
  "data": {
      "object": "Record",
      "record_id": "record_1",
      "collection_id": "collection_1",
      "status": "creating",
      "num_chunks": 1,
      "type": "qa_sheet",
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}
```

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

### Run LocalAI Service with Docker

Source: https://docs.tasking.ai/docs/guide/product_modules/model/supported_models/embedding_models/localai

Use this command to start a LocalAI service with GPU support. Ensure Docker is installed and the specified port (8090) is available.

```bash
docker run -ti -p 8090:8090 --gpus all localai/localai:v2.9.0-cublas-cuda11-core <model_name>
```

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

### Run LocalAI Service with Docker

Source: https://docs.tasking.ai/docs/guide/product_modules/model/supported_models/language_models/localai

Use this command to start a LocalAI service with GPU support. Ensure Docker is installed and the specified port (8090) is available. Replace `<model_name>` with your desired model.

```bash
docker run -ti -p 8090:8090 --gpus all localai/localai:v2.9.0-cublas-cuda11-core <model_name>  

```

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

### Install Dependencies

Source: https://docs.tasking.ai/docs/taskingai-inference/Installation-and-Setup

Install required Python packages from the requirements file.

```bash
pip install -r requirements.txt  
```

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

### Check Available Bundles

Source: https://docs.tasking.ai/docs/taskingai-plugin/usage

Send a GET request to this endpoint to retrieve a list of all available bundles. No specific setup is required beyond having access to the API.

```curl
curl --location 'http://127.0.0.1:8030/v1/bundles'
```

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

### File Upload Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/knowledge/upload-file

This is an example of a successful response after uploading a file. The `file_id` returned can be used to reference the uploaded file when creating records.

```json
{
  "status": "success",
  "data": {
    "file_id": "xlsx_file1"
  }
}
```

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

### Create Chat Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/assistant/manage_chats/create-a-chat

Example of the successful JSON response returned by the API, containing the chat object details and timestamps.

```json
{
  "status": "success",
  "data": {
      "object": "Chat",
      "chat_id": "chat_1",
      "assistant_id": "assistant_1",
      "name": "New Chat",
      "metadata": {"key1": "value1"},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}
```

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

### Run Docker Container

Source: https://docs.tasking.ai/docs/taskingai-inference/Installation-and-Setup

Start the service in a container, mapping port 8000 to the host.

```bash
docker run -d -p 8000:8000 taskingai/taskingai-inference:latest  
```

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

### Update Chat Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/assistant/manage_chats/update-a-chat

This is an example of a successful response when updating a chat. It includes the chat's current state and timestamps.

```json
{
  "status": "success",
  "data": {
      "object": "Chat",
      "chat_id": "chat_1",
      "assistant_id": "assistant_1",
      "name": "New Chat",
      "metadata": {"key1": "value1"},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}

```

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

### GET /assistants

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/manage_assistants/retrieve-assistants

Lists all assistants in the project with support for pagination and ordering.

```APIDOC
## GET /assistants

### Description
Retrieves a list of all assistants in the project.

### Method
GET

### Endpoint
/assistants

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Sets the maximum number of assistants to return.
- **order** (string) - Optional - Determines the order of the list ("asc" or "desc").
- **after** (string) - Optional - Cursor used for pagination to fetch assistants after a specific ID.
- **before** (string) - Optional - Cursor used for pagination to fetch assistants before a specific ID.

### Response
#### Success Response (200)
- **assistants** (array) - A list of Assistant objects.
```

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

### GET /v1/plugins

Source: https://docs.tasking.ai/docs/taskingai-plugin/usage

Retrieves a list of available plugins under a specific bundle.

```APIDOC
## GET /v1/plugins

### Description
Check available plugins under a specific bundle.

### Method
GET

### Endpoint
v1/plugins

### Parameters
#### Query Parameters
- **bundle_id** (string) - Required - The ID of the bundle to filter plugins by.

### Request Example
curl --location 'http://127.0.0.1:8030/v1/plugins?bundle_id=coin_market_cap'
```

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

### Start TaskingAI Services

Source: https://docs.tasking.ai/docs/guide/self-hosting-with-docker

Launch the application containers in detached mode using Docker Compose.

```bash
docker-compose -p taskingai --env-file .env up -d  
```

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

### Configure Action Authentication

Source: https://docs.tasking.ai/docs/guide/sdks/python/tool/action/create-an-action

Examples of different authentication types supported by TaskingAI actions.

```python
ActionAuthentication(  
    type=ActionAuthenticationType.NONE,  
)  
```

```python
ActionAuthentication(  
    type=ActionAuthenticationType.BASIC,  
    secret="YOUR_BASIC_SECRET"  
)  
```

```python
ActionAuthentication(  
    type=ActionAuthenticationType.BEARER,  
    secret="YOUR_BEARER_SECRET"  
)  
```

```python
ActionAuthentication(  
    type=ActionAuthenticationType.CUSTOM,  
    content={"Custom-Header": "CustomValue"}  
)  
```

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

### GET /actions

Source: https://docs.tasking.ai/docs/guide/sdks/python/tool/action/retrieve-actions

Retrieves a list of actions in the project with support for pagination.

```APIDOC
## GET /actions

### Description
Retrieves all actions in a project. Supports pagination using order, limit, after, and before parameters.

### Method
GET

### Parameters
#### Query Parameters
- **order** (string) - Optional - Sorting order of the records.
- **limit** (integer) - Optional - The number of records to return.
- **after** (string) - Optional - Cursor for pagination; returns records after this ID.
- **before** (string) - Optional - Cursor for pagination; returns records before this ID.

### Request Example
```python
import taskingai
actions = taskingai.tool.list_actions(limit=10)
```
```

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

### Run Ollama Model

Source: https://docs.tasking.ai/docs/guide/product_modules/model/supported_models/embedding_models/ollama

Command to start a specific model using the Ollama CLI.

```bash
ollama run <model_name>
```

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

### Create Record API Response

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/knowledge/create-a-record

Example response returned by the API upon a successful record creation request.

```json
{
  "status": "success",
  "data": {
      "object": "Record",
      "record_id": "record_1",
      "collection_id": "collection_1",
      "title": "Machine learning",
      "status": "creating",
      "num_chunks": 1,
      "type": "text",
      "content": "Machine learning is a subfield of artificial intelligence...",
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}
```

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

### Retrieve Record Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/knowledge/get-a-record

The JSON response structure returned upon a successful GET request for a specific record.

```json
{
  "status": "success",
  "data": {
      "object": "Record",
      "record_id": "record_1",
      "collection_id": "collection_1",
      "title": "record_1",
      "status": "creating",
      "num_chunks": 1,
      "type": "text",
      "content": "content",
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}
```

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

### Initialize taskingai with API Key

Source: https://docs.tasking.ai/docs/guide/sdks/python/quickstart

Alternatively, initialize the SDK by passing your API key directly to the `init` function in your Python code. Ensure you replace 'YOUR_API_KEY' with your actual key.

```python
import taskingai  
  
taskingai.init(api_key='YOUR_API_KEY')  
```

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

### Get Message Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/assistant/manage_messages/get-a-message

This JSON structure represents a successful response when retrieving a message. It includes message details like ID, role, content, and timestamps.

```json
{
  "status": "success",
  "data": {
      "object": "Message",
      "message_id": "message_1",
      "chat_id": "chat_1",
      "assistant_id": "assistant_1",
      "role": "user",
      "content": {"text": "What's the weather like today in New York?"},
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}
```

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

### Get Chat Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/assistant/manage_chats/get-a-chat

This JSON object represents a successful response when retrieving chat details. It includes status, chat ID, assistant ID, name, metadata, and timestamps.

```json
{
  "status": "success",
  "data": {
      "object": "Chat",
      "chat_id": "chat_1",
      "assistant_id": "assistant_1",
      "name": "New Chat",
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
  }
}

```

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

### List Plugins Response Sample

Source: https://docs.tasking.ai/plugin-api

Example response for listing plugins. It includes a status and a data array which may contain plugin information.

```json
{
  "status": "success",
  "data": [
    { }
]

}
```

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

### Create an Assistant with Tools

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/components/tools

Initializes an assistant with specific plugin tools defined by their IDs. Requires a valid model ID and pre-existing plugin configurations.

```python
import taskingai  
from taskingai.assistant import Assistant  
  
assistant: Assistant = taskingai.assistant.create_assistant(  
    model_id="YOUR_MODEL_ID",   
    name="My Multifunctional Assistant",  
    description="An assistant capable of providing weather updates and currency exchange rates.",  
    system_prompt_template=[  
        "You provide the latest weather updates.",  
        "You also offer current currency exchange rates."  
    ],  
    tools=[  
        {"type": "plugin", "id": "open_weather/get_current_weather"},  
        {"type": "plugin", "id": "exchangerate_api/get_exchange_rate"},  
    ],  
    memory={"type": "naive"},  
)  
print(f"created assistant: {assistant}\n")
```

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

### Create Assistant with System Prompt Template

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/components/system-prompt-template

Use this code to create a new assistant, defining its name, description, and a system prompt template with variables like {{language}}.

```python
import taskingai  

assistant = taskingai.assistant.create_assistant(  
    model_id="YOUR_MODEL_ID",  
    name="My Assistant",  
    description="A assistant who knows the meaning of various numbers.",  
    system_prompt_template=[  
        "You know the meaning of all numbers.",  
        "No matter what the user's language is, you will use {{language}} to explain."  
    ]  
)

```

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

### Initialize OpenAI Client for TaskingAI

Source: https://docs.tasking.ai/docs/developer-guide/openai/basic-usage

Initialize the OpenAI client with your TaskingAI API key and the specific base URL for TaskingAI's API. This setup is required before making any requests to your assistant applications.

```python
from openai import OpenAI  

client = OpenAI(  
    api_key="YOUR_TASKINGAI_API_KEY",  
    base_url="https://oapi.tasking.ai/v1",  
)
```

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

### Create an Assistant with TaskingAI

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/manage_assistants/create-an-assistant

Initializes a new assistant with a specified model, name, and memory configuration.

```python
import taskingai  
from taskingai.assistant.memory import AssistantNaiveMemory  
  
assistant = taskingai.assistant.create_assistant(  
    model_id="YOUR_MODEL_ID",  
    name="My Assistant",  
    description="This is my assistant",  
    system_prompt_template=["You are a professional assistant speaking {{language}}."],  
    memory={"type": "naive"},  
    tools=[],  
    retrievals=[],  
)  
```

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

### Execute Plugin Response Sample

Source: https://docs.tasking.ai/plugin-api

Example successful response after executing a plugin. Contains status and data, including execution details.

```json
{
  "status": "success",
  "data": {
    "status": 200,
    "data": { }
}

}
```

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

### Delete Record Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/knowledge/delete-a-record

This is an example of a successful response when deleting a record. Ensure your request includes the correct collection_id and record_id.

```json
{
  "status": "success"
}
```

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

### Initialize SDK with API Key

Source: https://docs.tasking.ai/docs/developer-guide/python-sdk/quickstart

Pass the API key directly to the init function within your Python script.

```python
import taskingai

taskingai.init(api_key='YOUR_API_KEY')
```

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

### Create an Assistant with Retrieval Integration

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/integration/integrate-with-retrieval

Use the create_assistant method to initialize an assistant with a specific collection and retrieval configuration.

```python
from taskingai.assistant import RetrievalConfig, RetrievalMethod  
  
assistant = taskingai.assistant.create_assistant(  
    # choose an available chat_completion model from your project  
    model_id="YOUR_MODEL_ID",  
    name="My Assistant",  
    retrievals=[{"type": "collection", "id": "YOUR_COLLECTION_ID"}],  
    memory={"type": "naive"},  
    retrieval_configs=RetrievalConfig(top_k=3, max_tokens=4096, method=RetrievalMethod.USER_MESSAGE, score_threshold=0.5)  
)  
```

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

### List Chats API Response Example

Source: https://docs.tasking.ai/docs/developer-guide/api-reference/assistant/manage_chats/list-chats

This is an example of the JSON response when listing chats. It includes chat details, timestamps, and pagination information.

```json
{
  "status": "success",
  "data": [
    {
      "object": "Chat",
      "chat_id": "chat_1",
      "assistant_id": "assistant_1",
      "name": "Name",
      "metadata": {},
      "updated_timestamp": 1730210035453,
      "created_timestamp": 1730210035453
    },
    ...
  ],
  "fetched_count": 20,
  "has_more": true
}

```

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

### Create an Assistant with Tools

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/integration/integrate-with-tools

Use the create_assistant method to initialize an assistant with specific tools defined by type and ID.

```python
from taskingai.assistant import Assistant, AssistantTool, AssistantToolType  
  
assistant: Assistant = taskingai.assistant.create_assistant(  
    model_id="YOUR_MODEL_ID",  
    memory={"type": "naive"},  
    tools=[  
        AssistantTool(  
            type=AssistantToolType.ACTION,  
            id="YOUR_ACTION_ID"),  
        AssistantTool(  
            type=AssistantToolType.PLUGIN,  
            id="YOUR_PLUGIN_ID"),  
    ]  
)  
```

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

### Navigate to Docker Directory

Source: https://docs.tasking.ai/docs/guide/self-hosting-with-docker

Change into the directory containing the Docker configuration files.

```bash
cd docker  
```

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

### GET /v1/bundles

Source: https://docs.tasking.ai/docs/taskingai-plugin/usage

Retrieves a list of all available bundles.

```APIDOC
## GET /v1/bundles

### Description
Retrieve a list of all available bundles.

### Method
GET

### Endpoint
v1/bundles

### Request Example
curl --location 'http://127.0.0.1:8030/v1/bundles'
```

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

### GET /v1/model_schemas

Source: https://docs.tasking.ai/inference-api

Retrieves a list of available model schemas.

```APIDOC
## GET /v1/model_schemas

### Description
Retrieves a list of available model schemas, which define the capabilities and properties of different AI models.

### Method
GET

### Endpoint
/v1/model_schemas

### Query Parameters
- **type** (string) - Optional - Filters models by type (e.g., "chat_completion").
- **provider_id** (string) - Optional - Filters models by provider ID.
- **lang** (string) - Optional - The language for the response. Defaults to "en".

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **data** (array) - An array of model schema objects.
  - **description** (string) - Description of the model schema.
  - **model_schema_id** (string) - The unique ID of the model schema.
  - **name** (string) - The name of the model.
  - **object** (string) - The object type, e.g., "ModelSchema".
  - **properties** (object) - Properties of the model schema.
    - **function_call** (boolean) - Indicates if function calling is supported.
    - **streaming** (boolean) - Indicates if streaming is supported.
  - **provider_id** (string) - The ID of the provider for this model.
  - **provider_model_id** (string) - The model ID as provided by the provider.
  - **type** (string) - The type of the model schema.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "description": "",
      "model_schema_id": "anthropic/claude-2.0",
      "name": "Claude 2.0",
      "object": "ModelSchema",
      "properties": {
        "function_call": false,
        "streaming": true
      },
      "provider_id": "anthropic",
      "provider_model_id": "claude-2.0",
      "type": "chat_completion"
    }
  ]
}
```
```

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

### Set Up Provider Credentials

Source: https://docs.tasking.ai/docs/taskingai-inference/usages/chat-completion/basic-usages

Pass the required API key for the chosen provider within the credentials field.

```json
{
    "credentials": {
        "OPENAI_API_KEY": "{{OPENAI_API_KEY}}"
    },
    ... other parameters in body
}
```

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

### GET /v1/providers

Source: https://docs.tasking.ai/inference-api

Retrieves a list of available AI model providers.

```APIDOC
## GET /v1/providers

### Description
Retrieves a list of available AI model providers, including their supported credentials and details.

### Method
GET

### Endpoint
/v1/providers

### Query Parameters
- **lang** (string) - Optional - The language for the response. Defaults to "en".

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **data** (array) - An array of provider objects.
  - **credentials_schema** (object) - The schema for provider credentials.
    - **properties** (object) - Properties of the credentials.
      - **ANTHROPIC_API_KEY** (object) - Description of the Anthropic API key.
        - **description** (string) - Description of the API key.
        - **secret** (boolean) - Indicates if the key is secret.
        - **type** (string) - The type of the field.
      - **ANTHROPIC_API_VERSION** (object) - Description of the Anthropic API version.
        - **description** (string) - Description of the API version.
        - **type** (string) - The type of the field.
    - **required** (array) - Required credential fields.
    - **type** (string) - The type of the schema.
  - **name** (string) - The name of the provider.
  - **object** (string) - The object type, e.g., "Provider".
  - **provider_id** (string) - The unique identifier for the provider.
- **lang** (string) - The language of the response.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "credentials_schema": {
        "properties": {
          "ANTHROPIC_API_KEY": {
            "description": "Your Anthropic API Key for authentication.",
            "secret": true,
            "type": "string"
          },
          "ANTHROPIC_API_VERSION": {
            "description": "The version of the Anthropic API being used.",
            "type": "string"
          }
        },
        "required": [
          "ANTHROPIC_API_KEY"
        ],
        "type": "object"
      },
      "name": "Anthropic",
      "object": "Provider",
      "provider_id": "anthropic"
    }
  ],
  "lang": "en"
}
```
```

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

### Retrieve and List Actions

Source: https://docs.tasking.ai/docs/guide/sdks/python/tool/action/retrieve-actions

Demonstrates how to list all available actions and retrieve a specific action by its ID.

```python
import taskingai  
  
actions = taskingai.tool.list_actions()  
  
action_id = actions[0].action_id  
action = taskingai.tool.get_action(action_id=action_id)  
```

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

### System Prompt Template and Variable Scenarios

Source: https://docs.tasking.ai/docs/guide/application_building/assistant/configuration/system-prompt

Examples demonstrating how system prompt templates behave when variables are provided or omitted.

```json
[
    "You are a health advisor providing {{advice_type}} advice",
    "Please respond with {{urgency}} urgency.",
    "You should always reply with a professional, kind, and patient tone."
]
```

```json
[
    "You are a health advisor providing nutritional advice",
    "Please respond with immediate urgency.",
    "You should always reply with a professional, kind, and patient tone."
]
```

```json
[
    "You are a health advisor providing nutritional advice",
    "You should always reply with a professional, kind, and patient tone."
]
```

```json
[
    "You should always reply with a professional, kind, and patient tone."
]
```

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

### Create a QA record using TaskingAI SDK

Source: https://docs.tasking.ai/docs/developer-guide/python-sdk/knowledge/create-a-record

Uploads a template file and creates a QA record in the specified collection. The record status must reach 'ready' before chunks can be retrieved.

```python
import taskingai   
  
file = taskingai.file.upload_file(file=open("PATH_TO_FILE", "rb"), purpose="qa_record_file")  
print(f"Uploaded file ID: {file.file_id}")  
  
record = taskingai.retrieval.create_record(  
    collection_id="YOUR_COLLECTION_ID",  
    type="qa_sheet",  
    file_id=file.file_id,  
)  
print(f"Created record: {record.record_id}\n")  
```

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

### GET /actions/{action_id}

Source: https://docs.tasking.ai/docs/guide/sdks/python/tool/action/retrieve-actions

Retrieves the details of a specific action by its unique identifier.

```APIDOC
## GET /actions/{action_id}

### Description
Retrieves a specific action using its unique action_id.

### Method
GET

### Parameters
#### Path Parameters
- **action_id** (string) - Required - The unique identifier of the action.

### Request Example
```python
import taskingai
action = taskingai.tool.get_action(action_id="your_action_id")
```
```

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

### Get Time by Timezone

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/time-api

Retrieves the current time for a specified IANA timezone.

```APIDOC
## GET time_api/get_time_by_timezone

### Description
Get the current time in a specific timezone.

### Parameters
#### Request Body
- **timezone** (string) - Required - The timezone to get the current time, in full IANA format, e.g. 'America/New_York'

### Response
#### Success Response (200)
- **result** (string) - The current time in the specified timezone in json format
```

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

### Get historical coin data

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/coin-market-cap

Retrieves historical information about a specific cryptocurrency.

```APIDOC
## POST coin_market_cap/get_historical_coin_data

### Description
Get the historical information about a cryptocurrency.

### Method
POST

### Endpoint
/websites/tasking_ai/plugins/coin_market_cap/get_historical_coin_data

### Parameters
#### Query Parameters
- **interval** (string) - Optional - The interval of the historical data. Supported values: yearly, monthly, weekly, daily, hourly, 5m, 15m, 30m, 45m, 1h, 2h, 3h, 4h, 6h, 12h, 1d, 2d, 3d...
- **symbol** (string) - Required - The symbol of the cryptocurrency. e.g. BTC, ETH, SOL, etc.
- **time_end** (string) - Optional - The end time of the historical data. Should be in the format of 'YYYY-MM-DD'
- **time_start** (string) - Optional - The start time of the historical data. Should be in the format of 'YYYY-MM-DD'

### Request Example
{
  "symbol": "BTC",
  "interval": "1d",
  "time_start": "2023-01-01",
  "time_end": "2023-01-31"
}

### Response
#### Success Response (200)
- **result** (json) - The historical information about the cryptocurrency in json format
```

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

### Create a Basic Chat Session

Source: https://docs.tasking.ai/docs/developer-guide/python-sdk/assistant/manage_chats/create-a-chat

Use the `create_chat` method with an `assistant_id` to start a new chat. The method returns a `Chat` object representing the session.

```python
import taskingai

chat = taskingai.assistant.create_chat(
    assistant_id="YOUR_ASSISTANT_ID",
    name='New Chat'
)
```

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

### GET /get_commodity_price

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/api-ninjas-commodity-price

Retrieves the current price information for a specified commodity item.

```APIDOC
## GET /get_commodity_price

### Description
Retrieves real-time commodity price information for a specific commodity item.

### Method
GET

### Endpoint
api_ninjas_commodity_price/get_commodity_price

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the commodity (e.g., 'Gold Futures')

### Response
#### Success Response (200)
- **result** (json) - Commodity price information of the commodity item.
```

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

### POST /assistants

Source: https://docs.tasking.ai/docs/guide/sdks/python/assistant/manage_assistants/create-an-assistant

Creates a new assistant with specified configurations.

```APIDOC
## POST /assistants

### Description
Creates a new assistant with specified configurations, including model, name, description, system prompt, memory, tools, and retrievals.

### Method
POST

### Endpoint
/assistants

### Parameters
#### Request Body
- **model_id** (string) - Required - The ID of a chat completion model available in your project.
- **name** (string) - Optional - The name for the assistant.
- **description** (string) - Optional - A brief description of the assistant.
- **system_prompt_template** (list[string]) - Optional - A list of system prompt chunks for defining the assistant's conversational flow and context. Prompt variables are wrapped in curly brackets.
- **memory** (object) - Required - Specifies the memory configuration for the assistant. Example: `{"type": "naive"}`.
- **tools** (list[object]) - Optional - A list of tools to enhance the assistant's capabilities.
- **retrievals** (list[object]) - Optional - A list of retrieval configurations for the assistant.
- **metadata** (object) - Optional - Additional metadata for the assistant. Can store up to 16 key-value pairs.

### Request Example
```json
{
  "model_id": "YOUR_MODEL_ID",
  "name": "My Assistant",
  "description": "This is my assistant",
  "system_prompt_template": ["You are a professional assistant speaking {{language}}."],
  "memory": {"type": "naive"},
  "tools": [],
  "retrievals": []
}
```

### Response
#### Success Response (200)
- **Assistant object** - Contains various properties and configurations of the newly created assistant, reflecting the settings and options specified during creation.
```

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

### Create Assistant with System Prompt Variables

Source: https://docs.tasking.ai/docs/developer-guide/python-sdk/assistant/manage_messages/generate-assistant-message

Define an assistant with a system prompt template that includes variables for dynamic behavior. These variables can be customized during message generation.

```python
assistant = taskingai.assistant.create_assistant(
    model_id="YOUR_MODEL_ID",
    memory={"type": "naive"},
    system_prompt_template=[
        "You are a virtual travel guide, providing information in {{language}} about places in {{country}}."
    ]
)
```

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

### Get Exchange Rate

Source: https://docs.tasking.ai/docs/integration/bundles-and-plugins/exchangerate-api

Retrieves the current exchange rate between two specified currencies.

```APIDOC
## GET /exchangerate_api/get_exchange_rate

### Description
Get current exchange rate from one currency to another.

### Method
GET

### Endpoint
/exchangerate_api/get_exchange_rate

### Parameters
#### Query Parameters
- **from_currency** (string) - Required - The currency code to convert from. Should be a 3-lettered currency code. e.g. USD, EUR, CNY, etc.
- **to_currency** (string) - Required - The currency code to convert to. Should be a 3-lettered currency code. e.g. USD, EUR, CNY, etc.

### Response
#### Success Response (200)
- **rate** (number) - The exchange rate from the from currency to the to currency.

### Response Example
{
  "rate": 0.85
}
```

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

### Bulk Create Actions with SDK

Source: https://docs.tasking.ai/docs/guide/sdks/python/tool/action/create-an-action

Uses the defined schema to register actions in TaskingAI.

```python
from taskingai.tool import Action  
from taskingai.tool import ActionAuthentication, ActionAuthenticationType  
from typing import List  
  
actions: List[Action] = taskingai.tool.bulk_create_actions(  
    openapi_schema=NUMBERS_API_SCHEMA,  
    authentication=ActionAuthentication(  
        type=ActionAuthenticationType.NONE,  
    )  
)  
```

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

### Execute Plugin Request Sample

Source: https://docs.tasking.ai/plugin-api

Sample payload for executing a plugin. Requires project ID, bundle ID, plugin ID, input parameters, and credentials.

```json
{
  "project_id": "string",
  "bundle_id": "bundle_1",
  "plugin_id": "plugin_1",
  "input_params": {
    "input_1": "value_1",
    "input_2": "value_2"
},
  "credentials": {
    "API_KEY": "YOUR_API_KEY"
}

}
```

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

### Get hourly forecast

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/open-weather

Retrieves an hourly weather forecast for a specified number of hours.

```APIDOC
## GET open_weather/get_hourly_forecast

### Description
Get hourly forecast based on latitude and longitude.

### Parameters
#### Inputs
- **hours** (integer) - Required - The number of hours to forecast. Max is 24.
- **lat** (number) - Required - Latitude of the location.
- **lon** (number) - Required - Longitude of the location.

### Response
- **result** (string) - result hourly forecasts in json string
```

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

### Get Assistant Info: Sync vs. Async

Source: https://docs.tasking.ai/docs/guide/sdks/python/async_python

Demonstrates retrieving assistant information using both synchronous and asynchronous TaskingAI API calls. Ensure you have the correct assistant ID.

```python
from taskingai.assistant import get_assistant
assistant1 = get_assistant(assistant_id="YOUR_ASSISTANT_ID")
```

```python
from taskingai.assistant import a_get_assistant
assistant2 = await a_get_assistant(assistant_id="YOUR_ASSISTANT_ID")
```

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

### Get daily forecast

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/open-weather

Retrieves a daily weather forecast for a specified number of days.

```APIDOC
## GET open_weather/get_daily_forecast

### Description
Get daily forecast based on latitude and longitude.

### Parameters
#### Inputs
- **days** (integer) - Required - The number of days to forecast. Max is 7.
- **lat** (number) - Required - Latitude of the location.
- **lon** (number) - Required - Longitude of the location.

### Response
- **result** (string) - result daily forecasts in json string
```

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

### Test TaskingAI with Python SDK

Source: https://docs.tasking.ai/docs/guide/self-hosting-with-docker

A script to initialize the client, create an assistant, and generate a chat response.

```python
import taskingai  
from taskingai.assistant.memory import AssistantNaiveMemory  
  
taskingai.init(api_key='YOUR_API_KEY', host='http://127.0.0.1:8080')   
  
# Create a new assistant  
assistant = taskingai.assistant.create_assistant(  
    model_id="YOUR_MODEL_ID",  
    memory=AssistantNaiveMemory(),  
)  
  
# Create a new chat  
chat = taskingai.assistant.create_chat(  
    assistant_id=assistant.assistant_id,  
)  
  
# Send a user message  
taskingai.assistant.create_message(  
    assistant_id=assistant.assistant_id,  
    chat_id=chat.chat_id,  
    text="Hello!",  
)  
  
# generate assistant response  
assistant_message = taskingai.assistant.generate_message(  
    assistant_id=assistant.assistant_id,  
    chat_id=chat.chat_id,  
)  
  
print(assistant_message)  
```

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

### GET news_api/search_news_article

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/news-api

Searches for news articles based on a query and optional date ranges.

```APIDOC
## GET news_api/search_news_article

### Description
Search for news articles.

### Plugin ID
news_api/search_news_article

### Parameters
#### Inputs
- **count** (integer) - Optional - The number of articles to return
- **from_date** (string) - Optional - The date and time for the oldest article allowed (ISO 8601 format).
- **query** (string) - Required - The search query.
- **to_date** (string) - Optional - The date and time for the newest article allowed (ISO 8601 format).

### Response
- **result** (string) - The search results in json string
```

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

### Check Available Plugins for a Bundle

Source: https://docs.tasking.ai/docs/taskingai-plugin/usage

Send a GET request to this endpoint, specifying a `bundle_id`, to find all plugins associated with that bundle. The response includes plugin details like ID, input/output schemas, and more.

```curl
curl --location 'http://127.0.0.1:8030/v1/plugins?bundle_id=coin_market_cap'
```

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

### GET news_api/get_top_headlines

Source: https://docs.tasking.ai/docs/guide/product_modules/plugin/bundles-and-plugins/news-api

Retrieves the top news headlines based on specified category and country.

```APIDOC
## GET news_api/get_top_headlines

### Description
Get the top headlines.

### Plugin ID
news_api/get_top_headlines

### Parameters
#### Inputs
- **category** (string) - Optional - The category you want to get headlines for. Must be one of: 'business', 'entertainment', 'general', 'health', 'science', 'sports', 'technology'
- **count** (integer) - Optional - The number of articles to return
- **country** (string) - Required - The 2-letter ISO 3166-1 code of the country you want to get headlines for.

### Response
- **result** (string) - The search results in json string
```
Tokens:
Raw