Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to the UBIK API! This guide will walk you through making your first API call in just a few minutes.
1

Get your API Key

Your API key is your passport to the UBIK ecosystem. You’ll need it to authenticate all of your API requests. You can find your API key in your user settings page on the UBIK dashboard.

Go to API Key Settings

Keep your API key secure as if it were a password and do not share it publicly.
2

Make Your First Request

Let’s verify that your API key is working correctly by fetching your user details. We’ll use the /users/me endpoint, which provides information about the authenticated user.
curl -X GET "https://app.ubik-agent.com/api/v1/users/me" \
     -H "X-API-KEY: YOUR_API_KEY"
3

Check the Response

If everything is correct, you’ll receive a 200 OK response with a JSON object containing your user details.
Response
{
  "username": "testuser",
  "full_name": "Test User",
  "uuid_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "created_at": "2025-09-28T12:00:00Z",
  "balance": 100.0,
  "chat_session_count": 5,
  "document_count": 42,
  "workspace_count": 3,
  "assistant_count": 2,
  "skill_count": 1
}
Congratulations! You’ve successfully made your first API call.

​
Next Steps

Now that you’re set up, you’re ready to explore more.

Core Concepts

Understand the fundamental building blocks of the UBIK API.

Step-by-Step Guides

Follow our guides to learn common workflows.