Refresh an access token

POST

/partner/authorization/token/refresh

curl --request POST \
  --url https://client-api.abi.ai/partner/authorization/token/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'refresh-token: Bearer eyJhbGciOi...' \
  --data '{ "subPartnerName": "partner_test" }'

• Abi Client API

Exchange the refresh token for a new access token. Send the refresh token in the refresh-token header using the Bearer scheme. Include subPartnerName in the optional JSON body only when the refreshed token must be scoped to a configured sub-partner.

Authorizations

• bearerAuth

Parameters

Header Parameters

refresh-token

required

string format: password

Refresh token sent as a Bearer token.

Example

Bearer eyJhbGciOi...

Request Body

Media typeapplication/json

Optional body used to scope the refreshed token to a configured sub-partner. The refresh token is sent in the refresh-token header, not in this body.

object

subPartnerName

Exact registered sub-partner name to scope the refreshed token.

string

Example

partner_test

Responses

200

Access and refresh tokens renewed.

Media typeapplication/json

object

access_token

Bearer token for authenticated API requests.

string

token_type

string

Allowed values: Bearer

refresh_token

Token used to obtain a replacement access token.

string

Example

{
  "access_token": "your_access_token",
  "token_type": "Bearer",
  "refresh_token": "your_refresh_token"
}

401

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}