Skip to main content
POST
/
auth
/
sign-in
Agent User Login
curl --request POST \
  --url https://scribe-api.puppilot.co/auth/sign-in \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "SecurePassword123"
}
'
{
  "access_token": "<string>",
  "refresh_token": "<string>",
  "token_type": "bearer",
  "expires_at": 1770000000,
  "refresh_expires_at": 1770004000,
  "user": {
    "id": "<string>",
    "email": "[email protected]",
    "name": "User Name",
    "organization_id": "<string>"
  }
}

​
Overview

Authenticate a user and receive an access token. This token is required to access this endpoint that necessitates user context (e.g., multi-shot chat endpoints). Access tokens have a defined validity period. Use the provided refresh token to obtain a new access token when the current one expires, allowing for continued authenticated access without re-entering credentials.

​
Request Body

  • email (string, required) - The user’s email address.
  • password (string, required) - The user’s password.

​
Example Request

{
  "email": "[email protected]",
  "password": "SecurePassword123"
}

​
Response (200 OK)

  • access_token (string) - The JWT access token for authenticating subsequent requests.
  • refresh_token (string) - The JWT refresh token used to obtain a new access token once the current one expires.
  • token_type (string) - The type of token, typically “bearer”.
  • expires_at (integer) - Unix timestamp indicating when the access token will expire.
  • refresh_expires_at (integer) - Unix timestamp indicating when the refresh token will expire.
  • user (object) - An object containing details about the authenticated user.
    • id (string, UUID) - The user’s unique identifier.
    • email (string) - The user’s email address.
    • name (string) - The user’s name.
    • organization_id (string, UUID) - The unique identifier of the organization the user belongs to.

​
Example Response (200 OK)

{
    "access_token": "<string>",
    "refresh_token": "<string>",
    "token_type": "bearer",
    "expires_at": 1770000000,
    "refresh_expires_at": 1770004000,
    "user": {
        "id": "<string>>",
        "email": "[email protected]",
        "name": "User Name",
        "organization_id": "<string>"
    }
}

Body

application/json
​
email
string<email>
required
​
password
string
required
Example:

"SecurePassword123"

Response

Successful login for agent services. Token valid for a specific duration.

​
access_token
string
Example:

"<string>"

​
refresh_token
string
Example:

"<string>"

​
token_type
string
Example:

"bearer"

​
expires_at
integer<int64>

Unix timestamp of when the access token expires.

Example:

1770000000

​
refresh_expires_at
integer<int64>

Unix timestamp of when the refresh token expires.

Example:

1770004000

​
user
object