Resources

A resource is a record type the CLI can operate on. The CLI’s registry defines which resources exist, which verbs each one supports, and what its aliases are.

The registry is the source of truth, not this page. Run oneocto resources for the live list with aliases and verbs, and oneocto describe <resource> for one resource’s contract.

Resources by area

The CLI currently exposes 44 resources.

Area	Resources
Workflows	workflows, workflow-versions, workflow-nodes, workflow-agents, workflow-transfers
Conversations	interactions, interaction-messages, interaction-workflows, entry-points, contacts
Agents and prompts	agents, agent-transfers, runnable-prompts, system-prompts, tools, llm-settings
Scheduling	schedules, schedule-executions
Telephony	phone-numbers, recordings, voice-usages
Analytics	dashboards, widgets, knowledge-sheets
Run history	workflow-execution-logs, node-execution-logs, audit-logs
Notifications	notification-templates, notification-logs
Billing	credits, purchases, transactions, transaction-items
Access and config	users, roles, user-roles, permissions, role-permissions, api-keys, spaces, settings, user-settings, platform-settings, feature-flags

Inspect a resource before using it

Do not guess whether a resource is space-scoped or which verbs it accepts. Ask:

oneocto describe tools     # verbs, fields, scoping, examples
oneocto explain tools      # how to think about the resource, and its pitfalls

describe returns the operational contract. explain returns guidance and links to longer-form docs for resources with non-obvious rules, such as workflow versions.

Canonical names and aliases

Each resource has one canonical CLI name — the human-friendly one used in commands — plus aliases that map from the underlying model names. Prefer the canonical name. Reach for an alias only when translating from an internal model name you already have.

Read-only resources

Append-only tables are read-only through the CLI. list and get work; create, update, and delete do not:

• Execution history: workflow-execution-logs, node-execution-logs
• The audit trail: audit-logs
• Billing ledgers: transactions, transaction-items

These records are written by the platform as things happen. Query them to investigate a run or reconcile usage.

Space scoping

Most resources belong to a space. The CLI resolves the space from --space-id, then ONEOCTO_SPACE_ID, then the tenant’s saved default, and can prompt for one in an interactive terminal. A few resources — platform settings and feature flags among them — sit above spaces. describe tells you which is which.

Working with many records at once

Use the storage group instead of looping a single-record verb, so the work travels in one request:

oneocto storage bulk create contacts --data '[{"name":"Support","type":"Number","endpoint":"+15559876543"}]'
oneocto storage bulk update contacts --data '[{"id":"<id>","name":"Support Line"}]'
oneocto storage bulk delete contacts --data '[{"id":"<id>"}]'

Set an association on an existing record, or create a record on one of its associations:

oneocto storage associate <resource> <id> --data '{...}'
oneocto storage create-related <resource> <id> <reference> --data '{...}'

Learn field shapes from a working example

The fastest way to get a payload right is to read one that already works:

oneocto list tools
oneocto get tools <id>

The returned record shows the real field shapes for that resource, including the nested configuration objects a schema summary flattens.

FAQ

How do I find out what verbs a resource supports? oneocto describe <resource>. Its response lists the supported verbs and any action commands such as publish or start-draft.

Why can’t I delete an execution log? Execution logs, the audit trail, and billing ledgers are append-only records of what happened. Making them editable would defeat their purpose.

A resource name in the console doesn’t match the CLI. The CLI uses canonical names that stay human-friendly even where the underlying model name is not. Run oneocto resources to see the aliases each resource accepts.

Related pages

• Command Reference - the verbs applied to these resources
• Flows - higher-level procedures across several resources
• Audit Logs - the audit trail the CLI reads
• Spaces - how space scoping works across the product