Skip to main content
POST
/
v2
/
auth
/
authenticate
Authenticate
curl --request POST \
  --url https://api.example.com/v2/auth/authenticate \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "provider": "<string>",
  "scopes": [
    "<string>"
  ],
  "agent_id": "<string>",
  "use_agent_builder_public_oauth": false
}
'
{
  "status": "completed",
  "url": "<string>",
  "auth_id": "<string>",
  "token": "<string>"
}

Body

application/json

Auth authenticate request.

​
user_id
string
required
​
provider
string
required
​
scopes
string[]
required
​
agent_id
string | null
​
use_agent_builder_public_oauth
boolean
default:false

Response

Successful Response

Auth authenticate response.

​
status
enum<string>
required

Valid authentication status values.

Available options:
completed,
pending
​
url
string | null
​
auth_id
string | null
​
token
string | null