Skip to main content
POST
/
ai
/
smart-brief
Smart Brief
curl --request POST \
  --url https://api.example.com/ai/smart-brief \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rawText": "<string>",
  "language": "en",
  "apiKey": "<string>",
  "aiProvider": "gemini",
  "openaiApiKey": "<string>",
  "anthropicApiKey": "<string>"
}
'
{
  "extraction": {
    "clientName": "<string>",
    "projectName": "<string>",
    "projectType": "<string>",
    "summary": "",
    "requirements": [],
    "timelineHint": "<string>",
    "budgetHint": "<string>",
    "clientLocation": "<string>",
    "industry": "<string>",
    "gaps": [],
    "briefQualityScore": 5
  },
  "success": true,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getquikly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Schema for smart brief extraction from raw text (meeting notes, emails, chats).

​
rawText
string
required
Required string length: 10 - 100000
​
language
enum<string>
default:en
Available options:
es,
en
​
apiKey
string | null
​
aiProvider
enum<string> | null
default:gemini
Available options:
gemini,
openai,
anthropic
​
openaiApiKey
string | null
​
anthropicApiKey
string | null

Response

Successful Response

Response for smart brief extraction.

​
extraction
SmartBriefExtraction · object
required

Structured data extracted from raw text.

​
success
boolean
default:true
​
error
string | null