Skip to main content
POST
/
ai
/
analyze-brief
Analyze Brief
curl --request POST \
  --url https://api.example.com/ai/analyze-brief \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "brief": "<string>",
  "language": "en",
  "apiKey": "<string>",
  "aiProvider": "gemini",
  "openaiApiKey": "<string>",
  "anthropicApiKey": "<string>",
  "existingRequirements": [
    {
      "name": "<string>",
      "id": "<string>",
      "description": "",
      "rationale": "",
      "complexity": 3,
      "priority": "medium",
      "manuallyEdited": false
    }
  ]
}
'
{
  "requirements": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "",
      "rationale": "",
      "nameUi": "<string>",
      "descriptionUi": "<string>"
    }
  ],
  "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 brief analysis request.

​
brief
string
required
Required string length: 10 - 50000
​
language
enum<string>
default:en
Available options:
es,
en
​
uiLanguage
enum<string> | null
Available options:
es,
en
​
apiKey
string | null
​
aiProvider
enum<string> | null
default:gemini
Available options:
gemini,
openai,
anthropic
​
openaiApiKey
string | null
​
anthropicApiKey
string | null
​
existingRequirements
ExistingRequirement · object[] | null

Response

Successful Response

Schema for brief analysis response.

​
requirements
RequirementResponse · object[]
required
​
success
boolean
default:true
​
error
string | null