Build a Proposal from an AI-Generated Outline

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/build' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-MSS-API-APPID: YOUR_API_APPID' \
  -H 'X-MSS-API-USERKEY: YOUR_API_USERKEY' \
  -H 'X-MSS-CUSTOM-DATE: Thu, 17 Apr 2026 12:00:00 GMT' \
  -H 'X-MSS-SIGNATURE: Base64EncodedHMACSHA256Signature' \
  -d '{"proposalId": 12345}'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/proposals/12345/ai/build"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/json"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, json={
    "proposalId": 12345
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/proposals/12345/ai/build";
const timestamp = new Date().toUTCString();
const contentType = "application/json";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: JSON.stringify({ proposalId: 12345 })
});
const data = await response.json();
console.log(data);

{
  "proposalId": 11538,
  "status": "Building"
}

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Bad Request: no completed AI outline exists for this proposal."
  }
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized to access this endpoint or your HMAC hash was incorrect."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this API call."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal not found."
  }
}

POST

public

proposals

{ProposalId}

build

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/build' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-MSS-API-APPID: YOUR_API_APPID' \
  -H 'X-MSS-API-USERKEY: YOUR_API_USERKEY' \
  -H 'X-MSS-CUSTOM-DATE: Thu, 17 Apr 2026 12:00:00 GMT' \
  -H 'X-MSS-SIGNATURE: Base64EncodedHMACSHA256Signature' \
  -d '{"proposalId": 12345}'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/proposals/12345/ai/build"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/json"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, json={
    "proposalId": 12345
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/proposals/12345/ai/build";
const timestamp = new Date().toUTCString();
const contentType = "application/json";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: JSON.stringify({ proposalId: 12345 })
});
const data = await response.json();
console.log(data);

{
  "proposalId": 11538,
  "status": "Building"
}

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Bad Request: no completed AI outline exists for this proposal."
  }
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized to access this endpoint or your HMAC hash was incorrect."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this API call."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal not found."
  }
}

Triggers an asynchronous AI build for the specified proposal, using its completed AI outline as the source. The proposal must have a Completed outline before you call this endpoint — if no completed outline exists, the request is rejected with a 400 error.

The build runs asynchronously. The response confirms the build has been queued, but the proposal content will not be ready immediately. Listen for the Proposal Build Status Changed webhook to know when the build finishes, or poll the proposal status directly.

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/build' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-MSS-API-APPID: YOUR_API_APPID' \
  -H 'X-MSS-API-USERKEY: YOUR_API_USERKEY' \
  -H 'X-MSS-CUSTOM-DATE: Thu, 17 Apr 2026 12:00:00 GMT' \
  -H 'X-MSS-SIGNATURE: Base64EncodedHMACSHA256Signature' \
  -d '{"proposalId": 12345}'

import requests
from portal_auth import sign_request

url = "https://api.portal.io/public/proposals/12345/ai/build"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
content_type = "application/json"
signature = sign_request("POST", url, content_type, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.post(url, headers={
    "Accept": "application/json",
    "Content-Type": content_type,
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
}, json={
    "proposalId": 12345
})
print(response.json())

const { signRequest } = require('./portalAuth');

const url = "https://api.portal.io/public/proposals/12345/ai/build";
const timestamp = new Date().toUTCString();
const contentType = "application/json";
const signature = signRequest("POST", url, contentType, timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    method: "POST",
    headers: {
        "Accept": "application/json",
        "Content-Type": contentType,
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    },
    body: JSON.stringify({ proposalId: 12345 })
});
const data = await response.json();
console.log(data);

Response

{
  "proposalId": 12345,
  "status": "Building"
}

Authorizations

X-MSS-API-APPID

string

header

required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY

string

header

required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE

string

header

required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE

string

header

required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

enum<string>

required

Accept Header

Available options:

application/json

Path Parameters

ProposalId

integer<int32>

required

Unique identifier corresponding to an existing proposal that has a completed AI outline; otherwise the request will be rejected with a 400 Bad Request.

Body

application/json

Proposals Service - AI Proposal Build

Response

Success

PublicAiProposalBuildPostResponse

proposalId

integer<int32>

required

Unique identifier corresponding to the proposal for which the build was triggered.

status

enum<string>

Available options:

Building,

Completed,

Failed

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Build a Proposal from an AI-Generated Outline

Authorizations

Headers

Path Parameters

Body

Response