POST
https://api.friendli.ai
/
serverless
/
tools
/
v1
/
chat
/
completions
curl --request POST \
  --url https://api.friendli.ai/serverless/tools/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "messages": [
    {
      "content": "What is 3 + 6?",
      "role": "user"
    }
  ],
  "model": "meta-llama-3.1-8b-instruct",
  "tools": [
    {
      "type": "math:calculator"
    }
  ]
}'
{
  "id": "chatcmpl-4b71d12c86d94e719c7e3984a7bb7941",
  "model": "meta-llama-3.1-8b-instruct",
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The result is 9."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 11,
    "total_tokens": 20
  },
  "created": 1735722153
}

See available models at this pricing table.

To request successfully, it is mandatory to enter a Friendli Token (e.g. flp_XXX) value in the Bearer Token field. Refer to the authentication section on our introduction page to learn how to acquire this variable and visit here to generate your token.

When streaming mode is used (i.e., stream option is set to true), the response is in MIME type text/event-stream. Otherwise, the content type is application/json. You can view the schema of the streamed sequence of chunk objects in streaming mode here.

You can explore examples on the Friendli Serverless Endpoints playground and adjust settings with just a few clicks.
Tool assisted chat completions does not fully support parallel tool calls now.

This API is currently in Beta. While we strive to provide a stable and reliable experience, this feature is still under active development. As a result, you may encounter unexpected behavior or limitations. We encourage you to provide feedback to help us improve the feature before its official release.

Authorizations

Authorization
string
header
required

When using Friendli Suite API for inference requests, you need to provide a Friendli Token for authentication and authorization purposes.

For more detailed information, please refer here.

Headers

X-Friendli-Team
string | null

ID of team to run requests as (optional parameter).

Body

application/json

Response

200
application/json

Successfully generated a tool assisted chat response.

The response is of type object.