API

The JoAi API lets you manage your AI workspace programmatically — agents, contacts, items, memories, goals, reminders, and more.

Base URL: https://api.joai.ai/api/v1

API Reference

Interactive reference:

api.joai.ai/docs

Authentication

Bearer token:

Authorization: Bearer <your-token>

Scope to a team:

X-Team-Slug: my-team

Or authenticate as an agent (team resolved automatically):

X-Agent-Auth-Key: <agent-auth-key>

Creating API tokens

Tokens are long-lived credentials scoped via X-Team-Slug.

Create them in the product from either:

1. Settings → API (personal settings navigator), or
2. Developers → API (/developers), or
3. Integrations → API Tokens install card

MCP: create_api_token (agent tooling).

OpenAPI & agents

Machine-readable JoAi OpenAPI (OAuth scopes included):

joai.ai/openapi.json

Also: JoAi developer index · SKILL.md · llms.txt

Prefer OpenAPI + SKILL.md for machine contracts. Product guides stay human-focused.

OAuth scopes

Scope	Meaning
mcp:read	Read MCP tools and resources
mcp:write	Mutating MCP tools
mcp:use	Full MCP use (read + write)

Discovery: https://joai.ai/.well-known/oauth-authorization-server · https://joai.ai/.well-known/oauth-protected-resource · API catalog · auth.md

Related

• API Tokens — create tokens in Integrations
• Developers
• MCP
• CLI
• Webhooks
• Integrations
• Teams