Welcome to the Osmosis API documentation. Our API helps you build smarter AI agents that learn and improve from experience.

​
Base URL

​
Authentication

All API requests require authentication using an API key in the x-api-key header.

See our Authentication Guide for detailed instructions.

​
API Endpoints

Task Enhancement

​
Enhance Task

POST /enhance_task

Enriches tasks with relevant knowledge and context from past interactions. Perfect for:

  • Adding historical context to queries
  • Improving response accuracy
  • Learning from past successes

Knowledge Storage

​
Store Knowledge

POST /store_knowledge

Stores agent interactions and experiences for future reference. Use it to:

  • Record successful interactions
  • Build a knowledge base
  • Track agent performance

Data Management

​
Delete by Intent

POST /delete_by_intent

Manages your knowledge base by removing outdated or irrelevant entries. Features:

  • Intent-based deletion
  • Semantic matching
  • Bulk operations

Job Status

​
Knowledge Status

GET /knowledge_status/{job_id}

Check the status of knowledge upload jobs. Features:

  • Real-time progress tracking
  • Job status monitoring
  • Error handling

​
Response Codes

​
Success Codes
object
​
Error Codes
object
​
Server Errors
object

​
Error Format

All API errors follow a consistent format:

Common error codes:

Getting Started

Set up authentication and make your first API call

API Examples

View detailed examples for each endpoint