Browse the API reference

Initialize OAuth Flow

post/v1/graphs/{graph_id}/connections/oauth/init

Part of Connections.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Request body

Required, application/json.

FieldTypeDescription
connection_idrequiredstring

Connection ID to link OAuth to

redirect_urioptionalstring

Override default redirect URI

additional_paramsoptionalobject

Provider-specific parameters

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/connections/oauth/init" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "connection_id": "string"
}'

Responses

200 Successful Response

FieldTypeDescription
auth_urloptionalstring

URL to redirect the user to for authorization. Null for providers that authorize in an embedded widget (Plaid: see link_token).

link_tokenoptionalstring

Plaid only: the token that opens Plaid Link. Link's public_token completes the flow through the callback, as code.

staterequiredstring

OAuth state for security

expires_atrequiredstring (date-time)

When this OAuth request expires

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error