Post Chat Completion | Fern Documentation

curl -X POST https://fai.buildwithfern.com/chat/domain \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "messages": [
    {
      "role": "user",
      "content": "Can you explain the benefits of using renewable energy sources?"
    }
  ]
}'

{
  "turns": [
    {
      "role": "user",
      "content": "Can you explain the benefits of using renewable energy sources?"
    },
    {
      "role": "assistant",
      "content": "Renewable energy sources, such as solar and wind power, provide sustainable and environmentally friendly alternatives to fossil fuels. They help reduce greenhouse gas emissions, decrease air pollution, and promote energy independence."
    }
  ],
  "citations": [
    "https://www.epa.gov/greenpower/benefits-green-power",
    "https://www.irena.org/renewable-energy"
  ]
}

curl -X POST https://fai.buildwithfern.com/chat/domain \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "messages": [
    {
      "role": "user",
      "content": "Can you explain the benefits of using renewable energy sources?"
    }
  ]
}'

{
  "turns": [
    {
      "role": "user",
      "content": "Can you explain the benefits of using renewable energy sources?"
    },
    {
      "role": "assistant",
      "content": "Renewable energy sources, such as solar and wind power, provide sustainable and environmentally friendly alternatives to fossil fuels. They help reduce greenhouse gas emissions, decrease air pollution, and promote energy independence."
    }
  ],
  "citations": [
    "https://www.epa.gov/greenpower/benefits-green-power",
    "https://www.irena.org/renewable-energy"
  ]
}

身份验证

AuthorizationBearer

Bearer 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

路径参数

domainstring必需

请求

This endpoint expects an object.

messageslist of objects必需

The messages to use for the chat completion

modelenum or null可选

The model to use for the chat completion

允许的值:

max_tokensinteger or null可选100-3500默认为 3000

The maximum number of tokens to generate. Note: setting a token count lower than 2000 may result in incomplete responses. You can add a custom system prompt to control the verbosity of the response.

system_promptstring or null可选

The system prompt to use for the chat completion

rewrite_queryboolean or null可选默认为 false

Whether to rewrite the query using query decomposition

响应

Successful Response

turnslist of objects

The conversation turns in the chat completion

citationslist of strings

List of citation strings

错误

422

Unprocessable Entity Error

$	curl -X POST https://fai.buildwithfern.com/chat/domain \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"messages": [
>	{
>	"role": "user",
>	"content": "Can you explain the benefits of using renewable energy sources?"
>	}
>	]
>	}'

1	{
2	"turns": [
3	{
4	"role": "user",
5	"content": "Can you explain the benefits of using renewable energy sources?"
6	},
7	{
8	"role": "assistant",
9	"content": "Renewable energy sources, such as solar and wind power, provide sustainable and environmentally friendly alternatives to fossil fuels. They help reduce greenhouse gas emissions, decrease air pollution, and promote energy independence."
10	}
11	],
12	"citations": [
13	"https://www.epa.gov/greenpower/benefits-green-power",
14	"https://www.irena.org/renewable-energy"
15	]
16	}