Quickstart

Make your first PerspioTalk API call in three steps.

PerspioTalk is Perspio's REST API. It uses standard HTTP methods, JSON and resource-based URLs, so any HTTP client or language can call it. This page takes you from nothing to a working API call in three steps.

Pick your region

Call the host for the region your Perspio tenant is in. Every API sits under that host, for example /assets/v3.

RegionBase URL
AUhttps://talk.perspio.io
UShttps://us-talk.perspio.io

The examples below use AU. For a US tenant, swap the host.

1. Create an API application

A Perspio administrator creates an API application for your integration in the Perspio web app. It gives you four values:

  • Client ID (client_id)
  • Client secret (client_secret)
  • Tenant ID (tid)
  • Subscription key (Ocp-Apim-Subscription-Key)

See Create Application for the steps.

❗️

Save the client secret

The client secret is only shown once, when the application is created. Store it somewhere safe, such as a secrets vault. If you lose it, generate a new one from the API application in Perspio.

2. Get an access token

Exchange the client ID and secret for an access token:

curl --request POST 'https://talk.perspio.io/auth/v3/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_id={client_id}' \
  --data-urlencode 'client_secret={client_secret}'
{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "expires_in": 3600,
  "token_type": "bearer"
}

The token lasts one hour. Reuse it for every call until then, and request a new one when it expires. Get Access Token has examples in other languages, plus token caching and errors.

3. Call an API

Send the token with your tenant ID and subscription key. This call to Get Assets lists the assets in your tenant:

curl --request GET 'https://talk.perspio.io/assets/v3/' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'tid: {tid}' \
  --header 'Ocp-Apim-Subscription-Key: {subscription_key}' \
  --header 'Accept: application/json'

A 200 OK response returns your assets as a JSON array. Every PerspioTalk API takes the same three headers.

👍

Try it in the browser

Every endpoint page has a Credentials panel. Enter your access token, tenant ID and subscription key there to send live requests with Try It, and copy ready-made code for cURL, Node.js, Python, C# and more.

Import into Postman

Every API's OpenAPI definition is public. Import one into Postman or Insomnia to get a ready-made collection for that API. OpenAPI Definitions has a download link for each.

Use these docs with AI assistants

Every page has a menu to copy it as Markdown or open it in ChatGPT or Claude. For tools that read documentation directly, the full index is at developers.perspio.io/llms.txt, and adding .md to any page's URL returns its Markdown.

Next steps

  • Authentication: how API applications, tokens and headers fit together.
  • REST API Overview: request methods, response codes, rate limits, dates and object IDs.
  • The API reference in the sidebar: each category, from Assets to Workflows, documents its endpoints with request and response examples.