API Reference Refresh Session
Refresh Session
Exchange a refresh token for a new access token and refresh token.
Trade the refresh token from Log In for a new pair. Access tokens last an hour; refresh tokens last 30 days and can be used once — each refresh returns a new refresh token and retires the old one.
Note
No valid access token is needed — send the expired one in Authorization if you have it, or nothing. The refresh token is the credential. Tokens issued by stx login are never refreshed here. Any plan.
Request Body
NameDescription
refreshTokenThe refresh token from your last sign-in or refresh, at least 10 characters.
Response
NameDescription
data.accessTokenA new session JWT. Send it as
Authorization: Bearer ….data.refreshTokenA new refresh token. Store it in place of the old one, which no longer works.
data.expiresInSeconds until the access token expires —
3600.The session keeps its identity across refreshes, so it stays the same entry in List Sessions.
Errors
| Status | Code | When |
|---|---|---|
| 400 | validation_error | refreshToken is missing or shorter than 10 characters |
| 401 | unauthorized | The refresh token is unknown, expired, already used, belongs to a deleted account, or its session was signed out |
Warning
Reusing a refresh token that was already exchanged signs that whole session out, because it suggests the token was copied. Sign in again with Log In.
Was this page helpful? Yes No
Previous
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/auth/refresh \
-H "Content-Type: application/json" \
-d '{ "refreshToken": "'"$SYNTEXT_REFRESH_TOKEN"'" }'
const response = await fetch('https://api.syntext.dev/v1/auth/refresh', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"refreshToken": "$SYNTEXT_REFRESH_TOKEN"
}),
});
const data = await response.json();
console.log(response.status, data);
import requests
url = "https://api.syntext.dev/v1/auth/refresh"
payload = {
"refreshToken": "$SYNTEXT_REFRESH_TOKEN",
}
response = requests.post(url, json=payload)
print(response.status_code)
print(response.json())
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{
"refreshToken": "$SYNTEXT_REFRESH_TOKEN"
}`)
req, err := http.NewRequest("POST", "https://api.syntext.dev/v1/auth/refresh", bytes.NewReader(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status)
fmt.Println(string(body))
}
require "json"
require "net/http"
require "uri"
uri = URI("https://api.syntext.dev/v1/auth/refresh")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"refreshToken" => "$SYNTEXT_REFRESH_TOKEN",
})
response = http.request(request)
puts response.code
puts response.body
<?php
$payload = [
'refreshToken' => '$SYNTEXT_REFRESH_TOKEN',
];
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.syntext.dev/v1/auth/refresh',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
echo $status, PHP_EOL, $response, PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String payload = """
{
"refreshToken": "$SYNTEXT_REFRESH_TOKEN"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.syntext.dev/v1/auth/refresh"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.syntext.dev/v1/auth/refresh");
request.Content = new StringContent(
"""
{
"refreshToken": "$SYNTEXT_REFRESH_TOKEN"
}
""",
Encoding.UTF8,
"application/json");
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
Responseapplication/json
200OK
{
"data": {
"accessToken": "eyJhbGciOiJIUzI1NiIs…",
"refreshToken": "c3f1…",
"expiresIn": 3600
}
}