> For the complete documentation index, see [llms.txt](https://argos-ci.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://argos-ci.com/docs/api-reference/reference/reviews.md). # Reviews Submit, list, and dismiss reviews to approve or reject the changes captured in a build. ## List the reviews submitted on a build > List the reviews submitted on a build, with pagination. ````json {"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"tags":[{"name":"Reviews","description":"Submit, list, and dismiss reviews to approve or reject the changes captured in a build."}],"servers":[{"url":"https://api.argos-ci.com/v2","description":"API Endpoint"}],"security":[{"personalAccessToken":[]}],"components":{"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Personal Access Token","description":"Authenticate as a **user** with a personal access token.\n\nSend it as a bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer \n```\n\nPersonal access tokens act on behalf of the user that created them\nand are required by endpoints that perform user actions, such as\nreviewing builds and posting comments."}},"schemas":{"BuildNumber":{"description":"The build number","type":"string"},"BuildReview":{"type":"object","properties":{"id":{"type":"string"},"buildId":{"type":"string"},"state":{"type":"string","enum":["approved","rejected","commented","pending"],"description":"State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft)."},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who submitted the review."},"dismissedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the review was dismissed, null if not dismissed."},"dismissedBy":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who dismissed the review, if any."},"date":{"type":"string","description":"Date the review was created."}},"required":["id","buildId","state","user","dismissedAt","dismissedBy","date"],"additionalProperties":false,"description":"Build review"},"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."},"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}},"paths":{"/projects/{owner}/{project}/builds/{buildNumber}/reviews":{"get":{"operationId":"listReviews","summary":"List the reviews submitted on a build","description":"List the reviews submitted on a build, with pagination.","tags":["Reviews"],"parameters":[{"in":"path","name":"owner","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"project","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"buildNumber","schema":{"$ref":"#/components/schemas/BuildNumber"},"required":true,"description":"The build number"}],"responses":{"200":{"description":"Build reviews","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuildReview"}}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ```` ## Create a review on a build > Submit a review on a build to approve or reject the changes it captured. ````json {"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"tags":[{"name":"Reviews","description":"Submit, list, and dismiss reviews to approve or reject the changes captured in a build."}],"servers":[{"url":"https://api.argos-ci.com/v2","description":"API Endpoint"}],"security":[{"personalAccessToken":[]}],"components":{"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Personal Access Token","description":"Authenticate as a **user** with a personal access token.\n\nSend it as a bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer \n```\n\nPersonal access tokens act on behalf of the user that created them\nand are required by endpoints that perform user actions, such as\nreviewing builds and posting comments."}},"schemas":{"BuildNumber":{"description":"The build number","type":"string"},"BuildReview":{"type":"object","properties":{"id":{"type":"string"},"buildId":{"type":"string"},"state":{"type":"string","enum":["approved","rejected","commented","pending"],"description":"State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft)."},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who submitted the review."},"dismissedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the review was dismissed, null if not dismissed."},"dismissedBy":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who dismissed the review, if any."},"date":{"type":"string","description":"Date the review was created."}},"required":["id","buildId","state","user","dismissedAt","dismissedBy","date"],"additionalProperties":false,"description":"Build review"},"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."},"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}},"paths":{"/projects/{owner}/{project}/builds/{buildNumber}/reviews":{"post":{"operationId":"createReview","summary":"Create a review on a build","description":"Submit a review on a build to approve or reject the changes it captured.","tags":["Reviews"],"parameters":[{"in":"path","name":"owner","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"project","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"buildNumber","schema":{"$ref":"#/components/schemas/BuildNumber"},"required":true,"description":"The build number"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"description":"Review event to apply to the build: \"APPROVE\", \"REJECT\" or \"COMMENT\". Required when `conclusion` is not provided.","type":"string","enum":["APPROVE","REJECT","COMMENT"]},"conclusion":{"deprecated":true,"description":"Deprecated: use `event` instead. Overall review conclusion for the build: \"APPROVE\" or \"REQUEST_CHANGES\".","type":"string","enum":["APPROVE","REQUEST_CHANGES"]},"body":{"description":"Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document."},"snapshots":{"default":[],"description":"Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the snapshot to review"},"conclusion":{"type":"string","enum":["APPROVE","REQUEST_CHANGES"],"description":"Review conclusion for this individual snapshot: \"APPROVE\" or \"REQUEST_CHANGES\""}},"required":["id","conclusion"]}}}}}}},"responses":{"200":{"description":"Review submitted successfully — returns the review","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildReview"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ```` ## Dismiss a submitted review on a build > Dismiss a previously submitted review on a build, clearing its effect on the build's review status. ````json {"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"tags":[{"name":"Reviews","description":"Submit, list, and dismiss reviews to approve or reject the changes captured in a build."}],"servers":[{"url":"https://api.argos-ci.com/v2","description":"API Endpoint"}],"security":[{"personalAccessToken":[]}],"components":{"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Personal Access Token","description":"Authenticate as a **user** with a personal access token.\n\nSend it as a bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer \n```\n\nPersonal access tokens act on behalf of the user that created them\nand are required by endpoints that perform user actions, such as\nreviewing builds and posting comments."}},"schemas":{"BuildNumber":{"description":"The build number","type":"string"},"BuildReview":{"type":"object","properties":{"id":{"type":"string"},"buildId":{"type":"string"},"state":{"type":"string","enum":["approved","rejected","commented","pending"],"description":"State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft)."},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who submitted the review."},"dismissedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the review was dismissed, null if not dismissed."},"dismissedBy":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who dismissed the review, if any."},"date":{"type":"string","description":"Date the review was created."}},"required":["id","buildId","state","user","dismissedAt","dismissedBy","date"],"additionalProperties":false,"description":"Build review"},"User":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","slug","name"],"additionalProperties":false,"description":"A user."},"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}},"paths":{"/projects/{owner}/{project}/builds/{buildNumber}/reviews/{reviewId}/dismiss":{"post":{"operationId":"dismissReview","summary":"Dismiss a submitted review on a build","description":"Dismiss a previously submitted review on a build, clearing its effect on the build's review status.","tags":["Reviews"],"parameters":[{"in":"path","name":"owner","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"project","schema":{"type":"string","minLength":1},"required":true},{"in":"path","name":"buildNumber","schema":{"$ref":"#/components/schemas/BuildNumber"},"required":true,"description":"The build number"},{"in":"path","name":"reviewId","schema":{"type":"string","description":"The ID of the review"},"required":true,"description":"The ID of the review"}],"responses":{"200":{"description":"Review dismissed successfully — returns the review","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildReview"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://argos-ci.com/docs/api-reference/reference/reviews.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.