Skip to main content
POST
/
ai
/
analyze-brief-discovery
Analyze Brief Discovery
curl --request POST \
  --url https://api.example.com/ai/analyze-brief-discovery \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "brief": "<string>",
  "language": "en",
  "apiKey": "<string>",
  "aiProvider": "gemini",
  "openaiApiKey": "<string>",
  "anthropicApiKey": "<string>",
  "projectName": "<string>",
  "clientName": "<string>",
  "proposalType": "<string>",
  "clarifyingAnswers": [
    {}
  ],
  "projectStartDate": "<string>",
  "projectDeadline": "<string>",
  "teamMembers": [
    {
      "roleName": "<string>",
      "seniority": "Junior",
      "allocation": 100,
      "availability": 123
    }
  ],
  "userProfile": {
    "providerType": "<string>",
    "role": "<string>",
    "seniority": "<string>",
    "skills": [
      "<string>"
    ],
    "workAreas": [
      "<string>"
    ],
    "weeklyHours": 123,
    "yearsOfExperience": 123,
    "aiReadinessLevel": 2
  },
  "clientBudget": 123,
  "clientBudgetType": "<string>",
  "availableProviders": [
    {
      "roleName": "<string>",
      "category": "team",
      "costType": "hourly",
      "rate": 123,
      "fixedCost": 123
    }
  ]
}
'
{
  "success": true,
  "questions": [],
  "ambiguities": [],
  "briefQualityScore": 5,
  "summary": "",
  "error": "<string>",
  "inputType": "<string>",
  "entities": {
    "projectType": "",
    "platforms": [],
    "features": [],
    "techStack": [
      "<string>"
    ],
    "userTypes": [
      "<string>"
    ],
    "integrations": [],
    "clientContext": ""
  },
  "estimationImpact": {
    "missingHighImpact": [
      "<string>"
    ],
    "missingMediumImpact": [
      "<string>"
    ],
    "wellDefined": [
      "<string>"
    ]
  },
  "teamAssessment": {
    "fitLevel": "no_team",
    "capacityWarnings": [
      "<string>"
    ],
    "roleGaps": [
      {
        "roleName": "<string>",
        "seniority": "Mid",
        "reason": ""
      }
    ],
    "strengths": [
      "<string>"
    ],
    "recommendation": ""
  },
  "resourceAssessment": {
    "suggestedLineItems": [
      {
        "label": "<string>",
        "amount": 0,
        "frequency": "one_time",
        "reason": "",
        "fromRoster": false
      }
    ],
    "missingResources": [
      {
        "roleName": "<string>",
        "reason": "",
        "estimatedCostRange": "",
        "priority": "medium"
      }
    ],
    "toolsAndInfra": [
      {
        "name": "<string>",
        "reason": "",
        "estimatedMonthlyCost": ""
      }
    ]
  },
  "typeRecommendations": {
    "proposalType": "<string>",
    "suggestedTerms": {},
    "reasoning": ""
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Schema for brief discovery analysis request (IN-25).

brief
string
required
Required string length: 10 - 50000
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
projectName
string | null
Maximum string length: 200
clientName
string | null
Maximum string length: 200
proposalType
string | null
Maximum string length: 50
clarifyingAnswers
Clarifyinganswers · object[] | null
projectStartDate
string | null
Maximum string length: 20
projectDeadline
string | null
Maximum string length: 20
teamMembers
BriefDiscoveryTeamMember · object[] | null
userProfile
BriefDiscoveryUserProfile · object

Lightweight profile snapshot for freelancer/team competency assessment.

clientBudget
number | null
clientBudgetType
string | null
Maximum string length: 20
availableProviders
BriefDiscoveryProvider · object[] | null

Response

Successful Response

Schema for brief discovery response (multi-agent pipeline).

success
boolean
default:true
questions
ClarifyingQuestion · object[]
ambiguities
BriefAmbiguity · object[]
briefQualityScore
integer
default:5
Required range: 1 <= x <= 10
summary
string
default:""
error
string | null
inputType
string | null
entities
ExtractedEntities · object

Structured entities extracted from the user's input by the Scope Analyst.

estimationImpact
EstimationImpact · object

How gaps affect the accuracy of the estimate.

teamAssessment
TeamAssessment · object

Quimy's assessment of team fitness for the project.

resourceAssessment
ResourceAssessment · object

Quimy's resource/provider assessment for the project.

typeRecommendations
TypeRecommendations · object

Type-specific commercial recommendations from gap_detective.