Talkamie APIs

sign up

Develop Env

https://test-api.talkamie.com/v1

POST

/auth/sign-up

Request

Header Params

x-user-device-id

string

optional

especially needed for enabling push notifications

Example:

some-user-device-id

x-auth-token

string

optional

especially when using an auth provider

Example:

some-token-from-auth-provider

x-user-timezone-offset

number

optional

in minutes; e.g, -180 means UTC+03:00 (3 hours ahead); 60 means UTC-01:00 (1 hour behind)

Example:

-240

Body Params application/json

string

required

name

string

optional

required, if not using an auth provider

password

string

optional

required, if not using an auth provider

authProvider

enum<string>

optional

Allowed values:

applegoogle

fcmDeviceToken

string

optional

for push notification, but the x-user-device-id must be present in the headers

Example

{
    "email": "string",
    "name": "string",
    "password": "string",
    "authProvider": "apple",
    "fcmDeviceToken": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.talkamie.com/v1/auth/sign-up' \
--header 'x-user-device-id: some-user-device-id' \
--header 'x-auth-token: some-token-from-auth-provider' \
--header 'x-user-timezone-offset: -240' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "name": "string",
    "password": "string",
    "authProvider": "apple",
    "fcmDeviceToken": "string"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "data": {
        "user": {
            "id": "string",
            "name": "string",
            "email": "string",
            "...": "..."
        },
        "tokens": {
            "access": "string",
            "refresh": "string"
        }
    }
}

Modified at 2025-05-30 02:29:19

get user by token