Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
get
/inboxes
List inboxes
post
/inboxes
Create an inbox
get
/inboxes/{id}
Get an inbox
delete
/inboxes/{id}
Delete an inbox
patch
/inboxes/{id}
Update an inbox
post
/inboxes/{id}/messages
Send from an inbox
post
/messages/batch
Send up to 100 messages
get
/messages
List messages
get
/messages/{id}
Get a message
get
/threads
List conversations
get
/threads/{id}
Get a conversation
get
/search
Full-text search across this org's mail
get
/attachments
List attachments on a message or a thread
get
/attachments/{id}
Signed download URL for one attachment
get
/approvals
Outbound messages held for a human
post
/approvals/{message_id}/approve
Release a held message
post
/approvals/{message_id}/reject
Reject a held message
get
/domains
List sending domains
post
/domains
Register a sending domain
post
/domains/{id}/warmup
Start or stop a sending warm-up
post
/domains/{id}/verify
Re-check DNS
get
/routes
List forwarding routes
post
/routes
Create a forwarding route
delete
/routes/{id}
Delete a route
patch
/routes/{id}
Enable or disable a route
get
/suppressions
Addresses this org must not send to
post
/suppressions
Suppress an address
delete
/suppressions/{id}
Un-suppress an address (by address)
get
/projects
List projects
post
/projects
Create a project
get
/projects/{id}
Get a project
delete
/projects/{id}
Delete a project
patch
/projects/{id}
Update a project
get
/jobs
List jobs (task templates)
post
/jobs
Create a job (task template)
get
/jobs/{id}
Get a job
delete
/jobs/{id}
Delete a job
patch
/jobs/{id}
Update a job
post
/jobs/{id}/run-now
Fire the job's real run right now (async)
post
/jobs/{id}/runs
Run a job with parameters (async)
get
/runs
List recent API runs
post
/runs
Run an inline prompt (async, no pre-created job)
get
/runs/{id}
Poll a task result
post
/runs/{id}/cancel
Cancel a running task
post
/runs/{id}/force
Jump a queued/deferred run ahead of a paused scheduler
get
/plans
List the plans OpenHelm Cloud offers (public, no key needed)
get
/settings/{key}
Read an account or machine setting
put
/settings/{key}
Write an account or machine setting
get
/executors
List this account's registered machines
patch
/executors/{id}
Sugar over PUT /settings for a specific machine
get
/tasks
List tasks OpenHelm has flagged for human attention
get
/tasks/{id}
Get a task
patch
/tasks/{id}
Update a task's status or resolution
get
/scheduler/status
Whether this account's scheduled execution is paused
post
/scheduler/pause
Pause ALL scheduled runs across every job and product in this account
post
/scheduler/resume
Resume scheduled execution after /scheduler/pause
get
/agents
List agents (Goals) — standing missions, each with its own jobs
get
/agents/{id}
Get an agent (Goal)
patch
/agents/{id}
Update an agent's mission, name, description, or status
post
/emails
Send an email from the org's identity
get
/emails/identity
Get the org's email address + inbound callback
post
/emails/identity
Allocate the identity + set the inbound webhook callback
get
/connections
List connections
post
/connections
Create a connection (token or mcp)
get
/connections/{id}
Get a connection
delete
/connections/{id}
Delete a connection (and its secret)
patch
/connections/{id}
Update a connection (name, enabled, rotate secret)
post
/connections/links
Mint a hosted connect link for an OAuth/browser provider
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
Get an agent (Goal)
get
/agents/{id}
Request
Base URL:
https://worker.openhelm.ai/v1
URL:
https://worker.openhelm.ai/v1/agents/{id}
Auth:
HTTP bearer
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.