Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
clientId
string
required

Client ID

redirectUri
string
required

Redirect URI

provider
enum<string>

Provider

Available options:
google,
github,
microsoft,
okta,
custom
authEndpoint
string

Authorization Endpoint

responseType
enum<string>

Response Type

Available options:
code,
token,
id_token,
code id_token
scopes
string

Scopes

usePkce
boolean

Add PKCE (code_challenge)

pkceMethod
enum<string>

PKCE Method

Available options:
S256,
plain
codeVerifierOverride
string

Code Verifier (optional override)

useState
boolean

Add state parameter (CSRF protection)

stateOverride
string

State (optional override)

useNonce
boolean

Add nonce parameter (OpenID Connect)

nonceOverride
string

Nonce (optional override)

extraParams
string

Extra Parameters

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.