Authenticate

Get OAuth token or start authentication flow if needed.

POST /v2/auth/authenticate

Authenticate

cURL

curl --request POST \
  --url https://api.example.com/v2/auth/authenticate \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "scopes": [
    "<string>"
  ],
  "user_id": "<string>",
  "ls_user_id": "<string>",
  "agent_id": "<string>",
  "use_agent_builder_public_oauth": false,
  "force_new": false,
  "token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_default": true
}
'

200

{
  "url": "<string>",
  "auth_id": "<string>",
  "token": "<string>",
  "user_id": "<string>",
  "metadata": {}
}

Body

application/json

Auth authenticate request.

provider · string · required

scopes · string[] · required

user_id · string | null

ls_user_id · string | null

agent_id · string | null

use_agent_builder_public_oauth · boolean · default: false

force_new · boolean · default: false

token_id · string<uuid> | null

is_default · boolean · default: true

Response

200

application/json

Successful Response

Auth authenticate response.

status · enum<string> · required

Valid authentication status values.

Available options: completed, pending, connection_required, token_expired

url · string | null

auth_id · string | null

token · string | null

user_id · string | null

metadata · Metadata · object