Generate an AI Outline for a Proposal

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -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/outline"
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/outline";
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": "Generating"
}

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Bad Request: the specified proposal does not contain the transcribed media or project specification content required for AI outline generation."
  }
}

{
  "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}

outline

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -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/outline"
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/outline";
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": "Generating"
}

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Bad Request: the specified proposal does not contain the transcribed media or project specification content required for AI outline generation."
  }
}

{
  "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."
  }
}

Starts asynchronous AI outline generation for the specified proposal. The proposal must contain transcribed project spec content or media transcripts — if no qualifying content is present, the request returns a 400 error. Once triggered, use Get Proposal Outline to check progress or listen for the Proposal Outline Status Changed webhook.

Outline generation is asynchronous. The 200 response confirms the job has been queued, but the outline will not be available immediately. Poll Get Proposal Outline and check for status: "Completed", or subscribe to the Proposal Outline Status Changed webhook.

curl -i -X POST \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -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/outline"
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/outline";
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": "Generating"
}

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

Proposal identifier. Must be a positive integer corresponding to an existing proposal. The proposal should contain transcribed project spec content or media transcripts; otherwise the request will be rejected with a 400 Bad Request.

Body

application/json

Proposals Service

Response

Success

PublicAiProposalOutlinePostResponse

proposalId

integer<int32>

required

ID of the proposal for which outline generation was triggered. Use this value to correlate asynchronous job progress and final outline results.

status

enum<string>

Available options:

Generating,

Completed,

Failed

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Generate an AI Outline for a Proposal

Authorizations

Headers

Path Parameters

Body

Response