Get a proposal
Read one proposal by id to see whether it was approved and how its run ended.
https://api.rankparse.com/v1/proposals/:idFreeAPI keyReturns one proposal of your workspace. Poll it after creating a proposal to learn the outcome once a person has decided. While it is pending, keep waiting or stop: proposing the same content again returns the same proposal.
Path parameters
idstringrequiredThe proposal id, prp_ followed by 16 to 40 URL-safe characters. A malformed id, an unknown id and another workspace's id all return the same 404 proposal_not_found.
Response
proposalobjectThe proposal summary, with the same fields as an item of List proposals: id, kind, status, title, site_id, source, estimated_credits, created_at, expires_at, decided_at, decided_via, result and error_code.
The summary never contains the URLs, email addresses, subjects or bodies of the proposal.
Errors
| HTTP | Code | When |
|---|---|---|
| 401 | invalid_api_key | Missing, invalid or revoked API key. |
| 404 | proposal_not_found | Malformed or unknown id, or a proposal of another workspace. |
| 429 | rate_limited | More than 60 requests in a minute. |
Related
MCP tool: get_proposal (takes proposal_id, the prp_... id from a propose tool or list_proposals), on both the API-key endpoint and the OAuth connector.