Skip to main content
The proposal API compares a vendor or implementation proposal with a generated specification. It returns a recommendation, alignment and confidence scores, strengths, concerns, gaps, and suggested changes.

Workflow

  1. Generate a Fast Spec or Deep Spec and wait for completion.
  2. Upload a proposal with proposalName and a file or text, or provide them directly to /vet-proposal.
  3. Vet the proposal using the specification ID and proposal content or an existing proposalId.
  4. Review the generated assessment; use list assessments or get assessment to retrieve it later.

Cost and retries

Vetting charges 100 credits per call before subsequent proposal lookup, content validation, and analysis. Verify your IDs and required content before submitting. There is no documented idempotency key or async mode for this operation; do not automatically retry a timeout, because another call can charge again. Uploading and retrieving a proposal do not themselves run the paid comparison. These operations use direct REST; there are no proposal methods in the official SDKs or product MCP tools.

Assessment fields

Use the scores with their supporting explanations when reviewing a proposal. They are generated assessments, not a guarantee of delivery or suitability.