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
}
]
}
'import requests
url = "https://api.example.com/ai/analyze-brief"
payload = {
"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
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.example.com/ai/analyze-brief', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/ai/analyze-brief",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/ai/analyze-brief"
payload := strings.NewReader("{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/ai/analyze-brief")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/ai/analyze-brief")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requirements": [
{
"id": "<string>",
"name": "<string>",
"description": "",
"rationale": "",
"nameUi": "<string>",
"descriptionUi": "<string>"
}
],
"success": true,
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}AI Services
Analyze Brief
Analyze a project brief and extract requirements using AI.
Required scope: read
Send a text description of a project and get back structured requirements with complexity and priority estimates.
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
}
]
}
'import requests
url = "https://api.example.com/ai/analyze-brief"
payload = {
"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
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.example.com/ai/analyze-brief', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/ai/analyze-brief",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/ai/analyze-brief"
payload := strings.NewReader("{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/ai/analyze-brief")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/ai/analyze-brief")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brief\": \"<string>\",\n \"language\": \"en\",\n \"apiKey\": \"<string>\",\n \"aiProvider\": \"gemini\",\n \"openaiApiKey\": \"<string>\",\n \"anthropicApiKey\": \"<string>\",\n \"existingRequirements\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"\",\n \"rationale\": \"\",\n \"complexity\": 3,\n \"priority\": \"medium\",\n \"manuallyEdited\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requirements": [
{
"id": "<string>",
"name": "<string>",
"description": "",
"rationale": "",
"nameUi": "<string>",
"descriptionUi": "<string>"
}
],
"success": true,
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Schema for brief analysis request.
Required string length:
10 - 50000Available options:
es, en Available options:
es, en Available options:
gemini, openai, anthropic Show child attributes
Show child attributes
⌘I