Skip to main content
POST
connector.connection.register

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
owner
object
required

Who the connection belongs to: {"kind":"org"} for your whole organisation, or {"kind":"end-user","endUserRef":"..."} for one of your end users. Pass the same owner on every later call. Take endUserRef from your own signed-in user, never from a browser.

url
string
required

The connector's address: public https on port 443, with no credentials, query or fragment. It is kept encrypted and never returned.

Maximum string length: 2048
auth
object
required

How to sign in: {"kind":"none"}, {"kind":"bearer","token":"..."}, or {"kind":"oauth","returnUrl":"..."} for a connector whose own service asks the person to approve access.

label
string

Your own label, up to 80 characters.

Required string length: 1 - 80

Response

The result

connectorRef
string
required

Names this connection in later calls. Not an address.

state
enum<string>
required

ready: tools can be listed and called. failed: see failureCode; disconnect it and register again. pending-auth: waiting for the person to approve access.

Available options:
pending-auth,
ready,
failed
authKind
enum<string>
required

How Pramaan signs in to the connector.

Available options:
none,
bearer,
oauth
createdAt
string
required

When it was registered, ISO 8601.

label
string

Your own label for it.

failureCode
enum<string>

Why it failed: access was refused, the credentials did not work, the address did not answer as a tool server, or it could not be reached.

Available options:
authorization-denied,
authorization-failed,
unsupported-protocol,
unreachable
connectUrl
string

Only when state is pending-auth: send the person's browser here to sign in and approve. Works once.

expiresAt
string

When connectUrl stops working, ISO 8601: 10 minutes after it was made.