Get the AI-Generated Outline for a Proposal

curl -i -X GET \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -H 'Accept: 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'

import requests
from portal_auth import sign_request  # See authentication guide

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

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

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

const url = "https://api.portal.io/public/proposals/12345/ai/outline";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

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

{
  "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 or outline not found."
  }
}

GET

public

proposals

{ProposalId}

outline

curl -i -X GET \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -H 'Accept: 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'

import requests
from portal_auth import sign_request  # See authentication guide

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

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

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

const url = "https://api.portal.io/public/proposals/12345/ai/outline";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

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

{
  "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 or outline not found."
  }
}

Returns the latest AI-generated outline for the specified proposal. The status field indicates whether generation is still in progress (Generating) or finished (Completed). The outline field is only populated once the status reaches Completed.

Outline generation is asynchronous. After calling Generate Proposal Outline, poll this endpoint or listen for the Proposal Outline Status Changed webhook to know when the outline is ready.

curl -i -X GET \
  'https://api.portal.io/public/proposals/12345/ai/outline' \
  -H 'Accept: 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'

import requests
from portal_auth import sign_request  # See authentication guide

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

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

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

const url = "https://api.portal.io/public/proposals/12345/ai/outline";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

Response (Completed)

{
  "proposalId": 12345,
  "status": "Completed",
  "outline": "## Executive Summary\nThis proposal covers the development of...\n\n## Scope of Work\n..."
}

Response (Generating)

{
  "proposalId": 12345,
  "status": "Generating",
  "outline": null
}

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 of the proposal to retrieve the AI-generated outline for.

Response

Success

PublicAiProposalOutlineGetResponse

proposalId

integer<int32>

required

Unique identifier of the proposal for which the outline is returned.

status

enum<string>

Available options:

Generating,

Completed,

Failed

outline

string

The AI-generated proposal outline text. This field is populated only when 'Status' is 'Completed'. When 'Status' is 'Generating' or 'Failed', this value will be null. The outline contains a structured summary of the proposal suitable for display or further processing by downstream agents.

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Get the AI-Generated Outline for a Proposal

Authorizations

Headers

Path Parameters

Response