Authentication

All API requests require a valid API key in the Authorization header.

Getting your API key

Go to Settings > API in the Finseo dashboard
Click Create API Key
Choose a name, scopes, and optionally restrict to specific projects
Copy the key immediately - it will only be shown once

Using your key

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.finseo.ai/v1/projects

import requests

headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get(
    "https://api.finseo.ai/v1/projects",
    headers=headers
)

const response = await fetch("https://api.finseo.ai/v1/projects", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

Verifying a key

GET /v1/me returns the account behind a key. Use it to check that a key is valid, to show users which account they connected, and to read the key’s scopes — it answers independently of whether the account has any projects yet, which makes it the right endpoint for integrations and connection tests.

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.finseo.ai/v1/me

{
  "data": {
    "id": "6a81e088f8ef06e062c40633",
    "email": "you@example.com",
    "accountName": "Your Company",
    "tier": "Business",
    "projectCount": 1,
    "scopes": ["read", "write"],
    "environment": "live"
  }
}

An invalid or revoked key returns 401 with error code UNAUTHORIZED.

Scopes

API keys can have one or more scopes:

Scope	Description
`read`	Read data (projects, prompts, metrics, competitors, sources)
`write`	Modify data (create prompts, update tags, manage projects)
`export`	Bulk export tracking data

Project restrictions

Optionally restrict a key to specific projects. A key with no project restrictions can access all projects owned by your account.

Key security

Never expose API keys in client-side code or public repositories.

Keys are hashed with SHA-256 before storage - we never store plaintext
Rotate keys regularly and revoke compromised keys immediately
Use test keys for development, live keys for production

Overview

Getting Started

Analytics

API Authentication & API Keys

Authentication

Getting your API key

Using your key

Verifying a key

Scopes

Project restrictions

Key security

​Authentication

​Getting your API key

​Using your key

​Verifying a key

​Scopes

​Project restrictions

​Key security

Authentication

Getting your API key

Using your key

Verifying a key

Scopes

Project restrictions

Key security