Skip to main content

​
Overview

The OpenSink API lets you send information, trigger execution, and inspect state from any platform. It is designed to be:
  • simple to integrate
  • explicit in behavior
  • safe to use from automation and AI agents
OpenSink works with any agent framework, any automation platform, and any programming language that can make HTTP requests.

​
Base URL

All API requests are made to: 
https://api.opensink.com/api/v1

​
Authentication

OpenSink uses API key authentication. Each request must include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Creating an API key

You can create and manage API keys from the API Keys page in the dashboard.
1

Open the dashboard

Navigate to the API Keys section of your workspace.
2

Create a new key

Give the key a name so you know where it’s used.
3

Copy and store securely

API keys are shown only once.
Treat API keys like passwords.
Do not commit them to source control or expose them in client-side code.

​
Authorization Model

API keys are scoped to a workspace. They can be used to:
  • create and read Sinks
  • write Items
  • manage Sessions
  • configure and trigger Background Jobs
Access is enforced at the workspace level.

​
Request & Response Format

  • All requests use JSON
  • All responses are JSON
  • UTF-8 encoding

​
Example request

curl -X POST https://api.opensink.com/api/v1/sinks/{sink_id}/items \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My first item",
    "body": "Hello from the OpenSink API"
  }'

​
Error Handling

OpenSink uses standard HTTP status codes.
StatusMeaning
200Success
201Created
400Invalid request
401Unauthorized
403Forbidden
404Not found
500Internal error
Error responses have the following shape: 
{
  "error": "Human-readable error message"
}

​
Idempotency & Safety

  • Item creation is append-only
  • Sessions are explicit and durable
  • Jobs are not auto-retried
OpenSink favors explicit state over implicit retries.

​
API Structure

The API is organized around a small set of resources:

Sinks & Items

Store and retrieve durable information.

Sessions

Track agent execution and resumability.

Background Jobs

Schedule execution without infrastructure.

Agents

Configure and execute agent behavior.

​
Next Steps

Create your first Sink

Learn how to store information in OpenSink.

Run an agent

Execute and track an agent using Sessions.