Signup

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

{
  "cookies": [
    {
      "name": "session_id",
      "value": "xyz789abc123...",
      "domain": ".github.com",
      "path": "/",
      "expires": 1791936891,
      "httpOnly": true,
      "secure": true,
      "sameSite": "Lax"
    }
  ],
  "origins": [
    "<string>"
  ],
  "credentialId": "cred_abc123xyz789",
  "expiresAt": "2024-12-31T23:59:59Z"
}

POST

signup

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

{
  "cookies": [
    {
      "name": "session_id",
      "value": "xyz789abc123...",
      "domain": ".github.com",
      "path": "/",
      "expires": 1791936891,
      "httpOnly": true,
      "secure": true,
      "sameSite": "Lax"
    }
  ],
  "origins": [
    "<string>"
  ],
  "credentialId": "cred_abc123xyz789",
  "expiresAt": "2024-12-31T23:59:59Z"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Registration credentials and method

Registration method to use.

Available options:

email,

oauth,

invitation

domain

string

required

Full URL to the signup page of the target website

Example:

"https://github.com/join"

cred

object

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]"

invite_token

string

Invitation token (required when signup_method is 'invitation')

Example:

"inv_abc123xyz789"

collectionId

string

Optional collection ID for organizing credentials

Example:

"col_abc123xyz789"

Response

Registration 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

credentialId

string

required

Reference ID for future refresh operations Stored credential ID for future refresh operations

Example:

"cred_abc123xyz789"

expiresAt

string<date-time>

Session expiration timestamp

Example:

"2024-12-31T23:59:59Z"

Refresh Session

⌘I

Overview

Authentication

API Reference

Authorizations

Body

Response