資料 API / DataForSEO / AI Optimization
Live Perplexity LLM Responses
Sends a user_prompt to a Perplexity model and returns its reply, synchronously. model_name must come from get_dataforseo_ai_perplexity_llm_responses_models - sonar, sonar-pro and sonar-reasoning-pro. web_search_country_iso_code scopes the search, which the other three vendors do not offer. Returns model_name, input_tokens, output_tokens, reasoning_tokens, web_search, money_spent, datetime, items and fan_out_queries. Read money_spent on the response to see what a prompt actually cost. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
參數
沒有路徑、查詢或請求標頭參數。
請求主體
user_promptstring必填prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field
model_namestring必填name of the AI model required field model_nameconsists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; you can receive the list of available LLM models by making a separate request to the following endpoint: https://api.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models
max_output_tokensinteger選填maximum number of tokens in the AI response optional field minimum value: 1 maximum value: 4096; default value: 2048; Note: if the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
temperaturenumber選填randomness of the AI response optional field higher values make output more diverse lower values make output more focused minimum value: 0 maximum value: 1.9 default value: 0.77
top_pnumber選填diversity of the AI response optional field controls diversity of the response by limiting token selection minimum value: 0 maximum value: 1 default value: 0.9
web_search_country_iso_codestring選填country code for web search localization optional field specify the country ISO code to get localized web search results Note: available only for Perplexity Sonar models example: US
system_messagestring選填instructions for the AI behavior optional field defines the AI's role, tone, or specific behavior you can specify up to 500 characters in the system_message field
message_chainobject[]選填conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
rolestring必填允許值: user · ai
messagestring必填tagstring選填user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
請求範例
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/perplexity/llm_responses/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user_prompt": "<string>",
"model_name": "<string>",
"max_output_tokens": 0,
"temperature": 0,
"top_p": 0,
"web_search_country_iso_code": "<string>",
"system_message": "<string>",
"message_chain": [
{}
]
}'回應
回應欄位
versionstring選填the current version of the API
status_codeinteger選填general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestring選填general informational message you can find the full list of general informational messages here
timestring選填execution time, seconds
costnumber選填total tasks cost, USD
tasks_countinteger選填the number of tasks in the tasks array
tasks_errorinteger選填the number of tasks in the tasks array returned with an error
tasksstring[]選填array of tasks
idstring選填task identifier unique task identifier in our system in the UUID format
status_codeinteger選填status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestring選填informational message of the task you can find the full list of general informational messages here
timestring選填execution time, seconds
costnumber選填cost of the task, USD includes the base task price plus the money_spent value
result_countinteger選填number of elements in the result array
pathstring[]選填URL path
dataobject選填contains the same parameters that you specified in the POST request
resultstring[]選填array of results
model_namestring選填name of the AI model used
input_tokensinteger選填number of tokens in the input total count of tokens processed
output_tokensinteger選填number of tokens in the output total count of tokens generated in the AI response
web_searchboolean選填indicates if web search was used Note: web search is enabled by default in Perplexity Sonar models
money_spentnumber選填cost of AI tokens, USD the price charged by the third-party AI model provider for according to its Pricing
datetimestring選填date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
itemsstring[]選填array of response items contains structured AI response data
typestring選填type of the element = 'message'
sectionsstring[]選填array of content sections contains different parts of the AI response
typestring選填type of element='text'
textstring選填AI-generated text content
annotationsstring[]選填array of references used to generate the response equals null if the web_search parameter is not set to true Note: annotations may return empty even when web_search is true, as the AI will attempt to retrieve web information but may not find relevant results
titlestring選填the domain name or title of the quoted source
urlstring選填URL of the quoted source
fan_out_queriesstring[]選填array of fan-out queries contains related search queries derived from the main query to provide a more comprehensive response