Login

curl --request POST \
  --url https://prismai.sh/api/login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cred": {
    "username": "[email protected]",
    "password": "securePassword123"
  },
  "loginMethod": "password",
  "domain": "https://github.com/login"
}
'

{
  "cookies": [
    {
      "name": "session_id",
      "value": "xyz789abc123...",
      "domain": ".github.com",
      "path": "/",
      "expires": 1791936891,
      "httpOnly": true,
      "secure": true,
      "sameSite": "Lax"
    }
  ],
  "origins": [
    "<string>"
  ]
}

POST

curl --request POST \
  --url https://prismai.sh/api/login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cred": {
    "username": "[email protected]",
    "password": "securePassword123"
  },
  "loginMethod": "password",
  "domain": "https://github.com/login"
}
'

{
  "cookies": [
    {
      "name": "session_id",
      "value": "xyz789abc123...",
      "domain": ".github.com",
      "path": "/",
      "expires": 1791936891,
      "httpOnly": true,
      "secure": true,
      "sameSite": "Lax"
    }
  ],
  "origins": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Enter your API key with 'pk_' prefix (from https://prismai.sh/workspace)

Body

application/json

Authentication credentials and method

cred

object

required

Show child attributes

cred.username

string

Username (required for 'password' method, optional for 'otp_email' and 'magic_link')

Example:

"[email protected]"

cred.password

string

User password (required for 'password' method, optional for 'otp_email' and 'magic_link')

Example:

"securePassword123"

cred.email

string<email>

Email address (optional for 'password' method, required for 'otp_email' and 'magic_link')

Example:

"[email protected]"

Authentication method to use. Currently supports 'password', 'otp_email', and 'magic_link'.

Available options:

password,

oauth_google,

oauth_github,

magic_link,

otp_email,

otp_sms,

totp

domain

string

required

Full URL to the login page of the target website

Example:

"https://github.com/login"

collectionId

string

Optional collection ID for organizing credentials

Example:

"col_abc123xyz789"

additionalFields

object

Optional key-value pairs for additional login parameters

Show child attributes

additionalFields.{key}

string

Example:

{ "account": "primary", "lastName": "Smith" }

useCache

boolean

default:true

Whether to use cached authentication sessions when available. If true (default), returns cached session cookies if a valid session exists for the domain and credentials within the collection. If false, forces fresh authentication through the browser automation system.

Example:

true

Response

Authentication successful

object[]

required

Array of session cookies to be set in the browser

Show child attributes

cookies.name

string

required

Cookie name

Example:

"session_id"

cookies.value

string

required

Cookie value containing session data

Example:

"xyz789abc123..."

cookies.domain

string

required

Domain where the cookie is valid

Example:

".github.com"

cookies.path

string

default:/

Path where the cookie is valid

Example:

"/"

cookies.expires

number

Unix timestamp when the cookie expires

Example:

1791936891

cookies.httpOnly

boolean

Whether the cookie is HTTP-only

Example:

true

cookies.secure

boolean

Whether the cookie requires HTTPS

Example:

true

cookies.sameSite

enum<string>

SameSite policy

Available options:

Strict,

Lax,

None

Example:

"Lax"

origins

string[]

required

Array of allowed origins for the session

Introduction

Signup

⌘I

Overview

Authentication

API Reference

Authorizations

Body

Response