Grade a volunteer form

Form Grader (upload, URL, pasted, or form id). id and reportUrl (/tools/r/{id}) are present only for public grades. Saved-form grades omit id and reportUrl; owners use GET /api/v1/forms/{id}/grade. Anonymous grades omit restricted field labels from parsed; the score still counts them. The API key is optional. Anonymous calls need a Turnstile token in production. A failed check is 400 with error turnstile. A missing Turnstile configuration is 503. Dev and test skip verification. Keyless agents should use /mcp or POST /a2a instead of calling this route without a token. formId or formVersionId requires forms:read and does not use Turnstile. A key without forms:read is treated as anonymous.

post/api/v1/tools/grade

Request

  • Base URL: https://applytovolunteer.com
  • URL: https://applytovolunteer.com/api/v1/tools/grade
  • Auth: one of:
    • HTTP bearer
    • none

Request body

urlstring

Page or file URL to grade or convert.

textstring

Plain text of the form. Used when url, pasted, and form are absent.

pastedunknown
formunknown
formIdstring

Saved form id. Requires an org API key with forms:read. Not anonymous. Convert rejects this.

formVersionIdstring

Saved form version id. Requires an org API key with forms:read. Convert rejects this.

turnstileTokenstring

Cloudflare Turnstile token. Required in production. Dev and test (ENVIRONMENT exactly dev or test) skip verification. A failed check is 400 with error turnstile. A missing Turnstile configuration is 503 with error turnstile_misconfigured. This token is not an org API key.

Response

Form Grader (upload, URL, pasted, or form id). id and reportUrl (/tools/r/{id}) are present only for public grades. Saved-form grades omit id and reportUrl; owners use GET /api/v1/forms/{id}/grade. Anonymous grades omit restricted field labels from parsed; the score still counts them.

idstring
reportobject required
parsedobject required
convertPathstring required
reportUrlstring

Changes

No recorded changes to this operation across all 1 revision of this API.