curl --request POST \
--url https://api.perplexity.ai/async/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request": {
"model": "sonar-deep-research",
"messages": [
{
"role": "system",
"content": "Be precise and concise."
},
{
"role": "user",
"content": "How many stars are there in our galaxy?"
}
],
"search_mode": "web",
"reasoning_effort": "low",
"max_tokens": 123,
"temperature": 0.2,
"top_p": 0.9,
"language_preference": "<string>",
"search_domain_filter": "<array>",
"return_images": false,
"return_related_questions": false,
"search_recency_filter": "<string>",
"search_after_date_filter": "<string>",
"search_before_date_filter": "<string>",
"last_updated_after_filter": "<string>",
"last_updated_before_filter": "<string>",
"top_k": 0,
"stream": false,
"presence_penalty": 0,
"frequency_penalty": 0,
"response_format": {},
"disable_search": false,
"enable_search_classifier": false,
"web_search_options": {
"search_context_size": "high"
},
"media_response": {
"overrides": {
"return_videos": true,
"return_images": true
}
}
}
}
'{
"id": "<string>",
"model": "<string>",
"created_at": 123,
"status": "CREATED",
"started_at": 123,
"completed_at": 123,
"response": {
"id": "<string>",
"model": "<string>",
"created": 123,
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"search_context_size": "<string>",
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123
},
"object": "chat.completion",
"choices": [
{
"index": 123,
"message": {
"content": "<string>",
"role": "system"
},
"finish_reason": "stop"
}
],
"search_results": [
{
"title": "<string>",
"url": "<string>",
"date": "2023-12-25"
}
],
"videos": [
{
"url": "<string>",
"thumbnail_url": "<string>",
"thumbnail_width": 123,
"thumbnail_height": 123,
"duration": 123
}
]
},
"failed_at": 123,
"error_message": "<string>"
}Creates an asynchronous chat completion job.
curl --request POST \
--url https://api.perplexity.ai/async/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request": {
"model": "sonar-deep-research",
"messages": [
{
"role": "system",
"content": "Be precise and concise."
},
{
"role": "user",
"content": "How many stars are there in our galaxy?"
}
],
"search_mode": "web",
"reasoning_effort": "low",
"max_tokens": 123,
"temperature": 0.2,
"top_p": 0.9,
"language_preference": "<string>",
"search_domain_filter": "<array>",
"return_images": false,
"return_related_questions": false,
"search_recency_filter": "<string>",
"search_after_date_filter": "<string>",
"search_before_date_filter": "<string>",
"last_updated_after_filter": "<string>",
"last_updated_before_filter": "<string>",
"top_k": 0,
"stream": false,
"presence_penalty": 0,
"frequency_penalty": 0,
"response_format": {},
"disable_search": false,
"enable_search_classifier": false,
"web_search_options": {
"search_context_size": "high"
},
"media_response": {
"overrides": {
"return_videos": true,
"return_images": true
}
}
}
}
'{
"id": "<string>",
"model": "<string>",
"created_at": 123,
"status": "CREATED",
"started_at": 123,
"completed_at": 123,
"response": {
"id": "<string>",
"model": "<string>",
"created": 123,
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"search_context_size": "<string>",
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123
},
"object": "chat.completion",
"choices": [
{
"index": 123,
"message": {
"content": "<string>",
"role": "system"
},
"finish_reason": "stop"
}
],
"search_results": [
{
"title": "<string>",
"url": "<string>",
"date": "2023-12-25"
}
],
"videos": [
{
"url": "<string>",
"thumbnail_url": "<string>",
"thumbnail_width": 123,
"thumbnail_height": 123,
"duration": 123
}
]
},
"failed_at": 123,
"error_message": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
Successfully created async chat completion job.
Unique identifier for the asynchronous job.
The model used for the request.
Unix timestamp of when the job was created.
The status of an asynchronous processing job.
CREATED, IN_PROGRESS, COMPLETED, FAILED Unix timestamp of when processing started.
Unix timestamp of when processing completed.
The actual chat completion response, available when status is COMPLETED.
Show child attributes
Unix timestamp of when processing failed.
Error message if the job failed.
Was this page helpful?