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": 123,
  "status": "<string>"
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

{
  "statusCode": 123,
  "statusDescription": "<string>",
  "responseHeaders": {},
  "responseDto": {},
  "responseBody": "<string>",
  "message": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "serverStackTrace": "<string>",
  "state": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123,
  "stackTrace": "<string>"
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

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": 123,
  "status": "<string>"
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

{
  "statusCode": 123,
  "statusDescription": "<string>",
  "responseHeaders": {},
  "responseDto": {},
  "responseBody": "<string>",
  "message": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "serverStackTrace": "<string>",
  "state": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123,
  "stackTrace": "<string>"
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

{
  "errorCode": "<string>",
  "stackTrace": "<string>",
  "contentType": "<string>",
  "headers": {},
  "cookies": [
    {}
  ],
  "status": 123,
  "statusCode": "<string>",
  "statusDescription": "<string>",
  "response": {},
  "responseFilter": {},
  "requestContext": {},
  "paddingLength": 123,
  "resultScope": {},
  "options": {},
  "responseStatus": {
    "errorCode": "<string>",
    "message": "<string>",
    "stackTrace": "<string>",
    "errors": [
      {
        "errorCode": "<string>",
        "fieldName": "<string>",
        "message": "<string>",
        "meta": {}
      }
    ],
    "meta": {}
  },
  "targetSite": {},
  "message": "<string>",
  "data": {},
  "innerException": {},
  "helpLink": "<string>",
  "source": "<string>",
  "hResult": 123
}

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

Headers

enum<string>

required

Accept Header

Available options:

application/json

X-MSS-API-APPID

string

required

Application Id

X-MSS-CUSTOM-DATE

string

required

A date timestamp of the request

X-MSS-SIGNATURE

string

required

A signature for the request

X-MSS-API-USERKEY

string

required

User API Key

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

proposalId

integer<int32>

required

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

string

required

Current status of the outline generation job. Consumers should poll or listen to webhooks to get final completed output when status becomes Completed.

Build a Proposal from an AI-Generated Outline

Search and List Contacts in Your Account

⌘I

Authentication

Proposals

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Generate an AI Outline for a Proposal

Headers

Path Parameters

Body

Response