Get started
Quickstart
Three calls from zero to a streamed execution. Copy the requests below, swap in your API key, and you're live.
1. Create an API key
Open OXYGEN, go to Settings → API, and create a runtime key. The secret is shown once — store it somewhere your agent can read as OXYGEN_API_KEY.
2. List the capabilities your org exposes
Capabilities include both GTM integrations (everything you've connected) and OXYGEN's durable memory. Each capability ships its own JSON-Schema-compatible input schema.
List capabilities
bash
curl https://oxygen-agent.com/api/runtime/capabilities \
-H "Authorization: Bearer $OXYGEN_API_KEY"3. Invoke a capability
Direct invocation creates a session for you automatically. The response includes a synchronous result plus an execution id you can stream.
Invoke memory_search
bash
curl -X POST https://oxygen-agent.com/api/runtime/tools/memory_search \
-H "Authorization: Bearer $OXYGEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"input": {
"query": "enterprise fintech ICP",
"limit": 5
}
}'Response
json
{
"session": { "id": "session_123", "status": "active" },
"capability": { "name": "memory_search", "kind": "memory" },
"runId": "run_123",
"executionId": "exec_123",
"executionEventsUrl": "https://oxygen-agent.com/api/runtime/executions/exec_123/events",
"summary": "1 hits",
"result": { "hits": [{ "path": "/topics/icp.md", "score": 10 }] }
}4. Stream the execution
Subscribe to the event stream to watch tool traces, checkpoints, and the terminal state. Streams are plain server-sent events — any SSE client works.
Open the stream
bash
curl -N https://oxygen-agent.com/api/runtime/executions/exec_123/events \
-H "Authorization: Bearer $OXYGEN_API_KEY"Next steps