All API requests to Osmosis require authentication. Your API key serves as both your authentication token and tenant identifier.

​
Getting an API Key

1

Request Access

Contact us at founders@gulp.ai to request API access.

2

Receive Credentials

Once approved, you’ll receive your unique API key via email.

3

Test Access

Verify your API key works by making a test call to any endpoint.

​
Using Your API Key

Include your API key in all requests to the Osmosis API using the x-api-key header:

​
Tenant ID

The tenant_id field in request bodies corresponds to a unique recommendation collection, enabling sub-tenancy isolation for different agentic workflows. This ensures proper data isolation and security between different agent instances and use cases.

Example request body structure:

# Basic authentication example
curl -X POST https://osmosis.gulp.dev/any_endpoint \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key" \
  -d '{
    "tenant_id": "your-api-key"
  }'

​
Error Handling

​
401 Unauthorized
object
{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or has been revoked"
}

​
Next Steps

API Reference

Explore the complete API documentation

Support

Contact us if you need help with authentication