Dimos Developer Documentation

Comprehensive guides and API references for building applications with Dimos. Find answers to technical questions and learn how to integrate our platform.

Getting Started

Installation


npm install @dimos/core

Quick Start

Initialize your project with the Dimos SDK to access all features:


import { DimosClient } from '@dimos/core';

const client = new DimosClient({
    apiKey: 'your-api-key',
    environment: 'production'
});

Integrations

REST API

Connect to our REST endpoints for programmatic access to all core features. Supports JSON and GraphQL.

GET https://api.dimos.com/v1/projects

Webhooks

Set up event listeners for project activity, file changes, and user actions through our webhook system.

POST /webhooks/event

API Reference

Core Methods

client.init({apiKey: string})

Initialize connection

client.createProject()

Create a new project

client.getProject()

Retrieve project details

client.deleteProject()

Remove a project

Response Format


{
  "status": 200,
  "data": {
    "id": "project-123",
    "name": "My Project",
    "createdAt": "2025-03-15T14:30:00Z"
  }
}

Guides

Authentication Flow

Learn how to implement secure authentication using OAuth2.0 protocol with our platform. Includes code samples and diagram.

Webhook Handling

Configure and manage webhook events in your application to enable real-time notifications from Dimos.

Example

JavaScript File upload example

const uploadFile = async (projectId, filePath) => {
    const uploadUrl = await client.getUploadUrl(projectId);
    
    const response = await fetch(uploadUrl, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/octet-stream'
        },
        body: fs.readFileSync(filePath)
    });

    if (response.ok) {
        return await client.finalizeUpload(projectId, filePath);
    }
};

Uploads files to project storage. Requires valid project ID and file path.