{"uid":"cap_wt2vpSDFPkIuyZsRICM8S","slug":"annotate-withzero-xyz-create-web-page-annotation-review-session-3aa68488","name":"Create Web Page Annotation Review Session","description":"Create an annotation review session. Pass `url` for a live webpage, or `zipData` (base64 zip) + optional `entryFile` for a static code bundle. Returns a `shareUrl` for the human reviewer and, for bundle reviews, a `bundleUrl` to download the original source afterward.","url":"https://annotate.withzero.xyz/api/v1/reviews","method":"POST","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["entryFile"],"properties":{"url":{"type":"string","format":"uri","description":"The URL of the page to annotate. Mutually exclusive with zipData."},"zipData":{"type":"string","description":"Base64-encoded zip of static site files (HTML/CSS/JS). When provided, the site is hosted by annotate and the reviewer annotates it directly. Mutually exclusive with url. Max 10 MiB decoded."},"entryFile":{"type":"string","default":"index.html","description":"Entry point filename within the zip. Defaults to index.html. Only used when zipData is provided."},"callbackUrl":{"type":"string","format":"uri","description":"Webhook URL to POST the full review JSON to when the human submits."}},"additionalProperties":false},"responseSchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["reviewId","shareUrl"],"properties":{"reviewId":{"type":"string","description":"UUID of the created review session."},"shareUrl":{"type":"string","description":"URL to share with the human reviewer."},"bundleUrl":{"type":"string","description":"Download URL for the original source zip. Present only for code-bundle reviews."}},"additionalProperties":false},"example":{"request":{"url":"https://example.com/sample-page","callbackUrl":"https://webhook.example.com/reviews/callback"},"response":{"reviewId":"7b34adad-96df-457c-97f5-6c5048210809","shareUrl":"https://annotate.withzero.xyz/p/36d24047-5ba3-4e9e-9ba3-85a2ce7a53c2"}},"exampleRequest":{"url":"https://example.com/sample-page","callbackUrl":"https://webhook.example.com/reviews/callback"},"tags":[],"displayCostAmount":"0.05","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"settled","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.05/call","primary":{"kind":"static","protocol":"mpp","network":"tempo","amountUsd":"0.05","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"mpp","network":"tempo","amountUsd":"0.05","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_t7VLTFKXZORVhGrQianAN","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"0.05","costPer":"request","priority":0,"asset":"0x20C000000000000000000000b9537d11c60E8b50","unit":"request","depositMicros":null,"planRef":"annotate.reviews.create:1"}],"brandName":"annotate.withzero.xyz","brandSlug":"annotate-withzero-xyz-mpp","brandBaseUrl":"https://annotate.withzero.xyz","brandDocsUrl":null,"whatItDoes":"Creates a shareable review session for a given URL so human reviewers can annotate it with click-to-pin comments, returning a share link and session ID.","exampleAgentPrompt":"Set up a web page annotation review session for https://myapp.com/landing-page and notify me at https://myserver.com/webhook when the reviewer submits their comments.","exampleUseCases":null,"resultDescription":"Returns a JSON object with a UUID reviewId for the created session and a shareUrl that can be sent to a human reviewer so they can open the page and leave click-to-pin annotations. The agent can poll or await a webhook callback at the provided callbackUrl to receive the full review JSON when the human submits.","failureModes":["Invalid or unreachable URL provided — returns 400 with validation error","Invalid callbackUrl format — returns 400 with schema validation error","Service unavailable — returns 503","Rate limit exceeded — returns 429","Payment not provided or insufficient — returns 402"],"whenToPreferThis":"Use this endpoint when you need a human to visually annotate or review a specific web page with click-to-pin comments. It is the right choice when you want to collect structured human feedback on a live URL and receive results via webhook, rather than running automated analysis.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-15T00:37:40.508Z","isFirstParty":true}