Skip to content

Start a connection of an assistant to one project

GET
/oauth/authorize
curl --request GET \
--url 'https://beta-api.plune.ai/oauth/authorize?response_type=code&client_id=example&redirect_uri=example&code_challenge=example&code_challenge_method=S256&resource=example&scope=read'

The authorization request of OAuth 2.1 with PKCE. Checks the client (a registered id, or the HTTPS address of a client metadata document, which is read from public addresses only), the exact redirect_uri (an http one on localhost, 127.0.0.1 or [::1] with any port), code_challenge_method=S256 and resource (the address of the MCP endpoint), keeps the request for 10 minutes and redirects (302) to the consent page of the web app with ?request=<id>, where the signed-in person picks one project and a right. Every refusal is a 400 answered here, never a redirect to the client. scope is read or write (write includes read); without it everything on offer is asked for, and the person narrows it. 60 requests in 15 minutes from one client address. Mounted only where the remote MCP server is switched on (MCP_PUBLIC_URL); elsewhere 404.

response_type
required
string
Allowed values: code
client_id
required
string
redirect_uri
required
string
code_challenge
required
string
code_challenge_method
required
string
Allowed values: S256
resource
required
string
scope
string
Allowed values: read write
state
string

To the consent page of the web app

Location
string

invalid_request, invalid_client, invalid_target, invalid_scope or unsupported_response_type

Media type application/json
object
error
required
string
error_description
string
Example
{
"error": "invalid_request",
"error_description": "PKCE is required: code_challenge with code_challenge_method=S256"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over