For AI agents: visit https://support.onify.co/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides Blueprints Community Changelog API Reference Get support

Home Guides API Reference Changelog Community

Home Guides Blueprints Community Changelog API Reference Get support Log In

API Reference

Agent endpoints

resources
- Get agents file listget
- Get agents file contentget
task
- Get Agent task by idget
- Update Agent task by idpatch
register
- Register new Agentpost

My endpoints

administration
- Get administration configurationsget
audit
- List my Audit recordsget
- Create Audit recordpost
bulletins
locales
- List Localeget
logoff
- User Logoffget
notifications
processes
settings
- Get my Settingsget
- Update my Settingspost
shortcuts
strings
- Get user strings by localeget
- Get user strings timestampget
users
- List Usersget
workspaces
config
dashboards
- Get Dashboard by slugget
forms
guides
- Get Guide by slugget
items
options
- List Options by tagsget
- List Options by tagsget
resources
- Get my dashboards listget
- Get my forms listget
workflows
agent
login
- User Loginpost
connector
- Run Pipelinepost

Setup endpoints

database

Tools endpoints

logs
- Get logsget
- Error loggingpost
docs
- Get documentation by pathget
elastic
encrypt
- Encrypt stringpost
sendmail
- Send Emailpost

Admin endpoints

agents
audit
bulletins
dashboards
domains
events
files
- List temporary filesget
- Get temporary file by idget
forms
guides
instances
- Onify Hub instancesget
- Onify Hub instancesget
items
locales
notifications
options
processes
resources
roles
shortcuts
strings
users
workflows
workspaces
config
connector
bulk
import
- Imports settingspost

Public endpoints

resources
- Get public files listget
- Get public filesget
settings
- Get public settingsget
strings
- Get public stringsget

Files endpoints

private
- Get private temporary fileget
- Create private temporary filepost
public
- Get public temporary fileget
- Create public temporary filepost
{access}
- Delete temporary filedel

Powered by

Create (or update) Guides

post

http://dev-api.onify.net/api/v2/admin/guides

Query Params

refresh

boolean

Body Params

slug

string

^\S*$

title

string

required

name

string

required

description

string

instructions

string

role

array of strings

role

tag

array of strings

tag

domain

array of strings

domain

step

array of objects

required

step*

Headers

authorization

string

required

Response

Updated 12 months ago

Get guide by slug

Language

Loading…

Response

Choose an example:

*/*

Updated 12 months ago

Get guide by slug