Check an API key

GET/v1/me

Any valid key, whatever its scopes: the workspace it acts in and the key itself. Use it as a connection test; a revoked, expired or unknown key is 401. A partner key with Kirora-Workspace names that tenant as workspace.

Returns

Returns 200 OK with a ApiCaller in data. Otherwise returns an error; Errors lists every code and which to retry.

workspaceobjectrequired

The workspace the request acts in.

2 child attributes

idstringrequired: uuid
namestringrequired

apiKeyobjectrequired

The key making the request.

5 child attributes

idstringrequired

uuid

namestringrequired

kindstringrequired

agent keys cannot send; see the agents guide.

one of integration, agent, partner

sourcestring | nullrequired

The integration the key was made for, if any.

one of zapier, make, n8n, http_api

scopesstring[]required

What the key may do.

curl https://api.kirora.io/v1/me \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/me', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/me", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "workspace": {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "name": "Weekend specials"
    },
    "apiKey": {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "name": "Weekend specials",
      "kind": "integration",
      "source": "zapier",
      "scopes": [
        "campaigns:read"
      ]
    }
  }
}

Example values are generated from the schema.