neosourceDocs
Search docs

Open an inline review thread on a pull request

POST/api/repos/{owner}/{repo}/pulls/{number}/threads

createPullRequestThread

Anchors a thread at `(path, line, side)` against the PR's current head commit (or an explicit `anchor_commit`). Replies attach through the unified comments endpoint once the thread is open.

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X POST 'https://neosource.dev/api/repos/OWNER/REPO/pulls/NUMBER/threads' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"anchor_path":"string","anchor_line":0,"anchor_side":"string"}'

fetch

fetch("https://neosource.dev/api/repos/OWNER/REPO/pulls/NUMBER/threads", {
  method: "POST",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"anchor_path":"string","anchor_line":0,"anchor_side":"string"}),
});

Path parameters

ownerrequired

Repository owner or organization slug.

string

reporequired

Repository name.

string

numberrequired

Change request number.

integerint32

Request bodyrequired

application/json

CreatePrReviewThreadRequest

object

anchor_commit

string | null

Hex commit OID the line is anchored at. Defaults to the PR's current head commit when omitted.

anchor_linerequired

integerint32

anchor_pathrequired

string

anchor_siderequired

ThreadSide

string

Side of the diff a review thread anchors to. `Old` = the line was on the pre-image (red side); `New` = the line is on the post-image (green side). Identical encoding to GitHub's `RIGHT`/`LEFT` but spelled in our domain.

"old""new"

Responses

201Thread created

application/json

PrReviewThreadResponse

object

anchor_commitrequired

string

40-char Git OID hex of the commit the line is anchored at.

anchor_linerequired

integerint32

anchor_pathrequired

string

anchor_siderequired

ThreadSide

string

Side of the diff a review thread anchors to. `Old` = the line was on the pre-image (red side); `New` = the line is on the post-image (green side). Identical encoding to GitHub's `RIGHT`/`LEFT` but spelled in our domain.

"old""new"

created_atrequired

integerint64

created_byrequired

string

outdated_at

integer | nullint64

pr_idrequired

string

resolved_at

integer | nullint64

resolved_by

string | null

thread_idrequired

string

updated_atrequired

integerint64

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 403Forbidden — one of: forbidden
  • 404Not Found — one of: not_found
  • 409Conflict — one of: already_exists, conflict, non_fast_forward
  • 423Locked — one of: busy
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget