Developers

Build with OneFoundry. Create useful work.

APIs for teammates, work products, decisions, connectors, workspace memory, and events.

Start with one teammate

Install the SDK and create a focused teammate.

1. Install the SDK

npm install @onefoundry/sdk

2. Create a teammate

import { OneFoundryClient } from '@onefoundry/sdk';

const onefoundry = new OneFoundryClient({
  apiKey: process.env.ONEFOUNDRY_API_KEY,
});

// Hire a teammate for one focused outcome
const teammate = await onefoundry.teammates.create({
  role: 'research',
  outcome: 'Prepare a cited market brief for the executive team',
});

console.log(teammate.id);

from onefoundry_sdk import OneFoundryClient

client = OneFoundryClient(api_key="your-api-key")

# Hire a teammate for one focused outcome
teammate = client.teammates.create(
    role="research",
    outcome="Prepare a cited market brief for the executive team",
)

print(teammate.id)

curl -X POST https://api.onefoundry.app/v1/teammates \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "research",
    "outcome": "Prepare a cited market brief for the executive team"
  }'

API capabilities

Teammate API

Create teammates, assign work, read run state, and inspect receipts.

Work Products API

Create, refresh, and retrieve saved outputs like briefs, lists, reports, and dashboard previews.

Memory API

Read and write workspace memory with consent, source links, and retention controls.

Events API

Subscribe to teammate runs, decisions, receipts, and monitor triggers.

Auth API

OAuth and workspace authentication with scoped permissions.

Admin API

Manage users, roles, budgets, audit logs, and connector status programmatically.

Key endpoints

POST/v1/teammatesHire a teammate for a defined role and first outcome

GET/v1/work-productsList saved work products with status and source context

POST/v1/decisions/{id}/approveApprove a decision packet after human review

GET/v1/runs/{id}Check teammate run status and proof links

POST/v1/events/subscribeSubscribe to workspace events via webhooks

Developer resources

Build on reviewed examples

Use the public examples to understand teammate creation, work-product retrieval, decision approval, and event subscriptions before connecting production systems.

Example appsAPI patternsConnector review

Explore on GitHub

Connector SDK

Bring internal tools into OneFoundry.

Define custom APIs, classify permissions, test safely, and publish connector access only after review.

Connector docs View Changelog

Build with the team

Use the docs, inspect examples, and bring us the workflow you want OneFoundry to support next.

Contact developers GitHub

Loading OneFoundry

import { OneFoundryClient } from '@onefoundry/sdk'; const onefoundry = new OneFoundryClient({ apiKey: process.env.ONEFOUNDRY_API_KEY, }); // Hire a teammate for one focused outcome const teammate = await onefoundry.teammates.create({ role: 'research', outcome: 'Prepare a cited market brief for the executive team', }); console.log(teammate.id);

from onefoundry_sdk import OneFoundryClient client = OneFoundryClient(api_key="your-api-key") # Hire a teammate for one focused outcome teammate = client.teammates.create( role="research", outcome="Prepare a cited market brief for the executive team", ) print(teammate.id)

curl -X POST https://api.onefoundry.app/v1/teammates \ -H "Authorization: Bearer your-api-key" \ -H "Content-Type: application/json" \ -d '{ "role": "research", "outcome": "Prepare a cited market brief for the executive team" }'