Skip to content
SupaCloud Docs
Select themeSelect language

post_api_tasks_id_pr

POST
/api/tasks/{id}/pr
curl --request POST \
  --url https://example.com/api/tasks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pr \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "bypass_reason": "example", "description": "example", "title": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Task id

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
bypass_reason

Optional reason to bypass the exfil boundary check

string | null
description

Optional pull request description (defaults to a task summary)

string | null
title

Optional pull request title (defaults to task title)

string | null
Examplegenerated
{
  "bypass_reason": "example",
  "description": "example",
  "title": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Pull request created

Media typeapplication/json

The opened pull request — the forge PR number, its web URL and the title the forge recorded. Mirrors the JSON body the create_pull_request service builds; the handler deserializes the service’s serde_json::Value into this typed DTO so the OpenAPI 200 body is honest and compiler-checked.

object
pr_id
required

The forge-assigned pull request number.

integer format: int64
pr_url
required

The pull request’s web URL.

string
title
required

The title the forge recorded for the pull request.

string
Examplegenerated
{
  "pr_id": 1,
  "pr_url": "example",
  "title": "example"
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}