Index
Dokki API
185 published pieces
Get credits
GET /api/v1/credits Use this endpoint to get credits. Endpoint Method: GET Path: /api/v1/credits Required scope: credit:read Base URL: https://dokki.one Route source: app/api/v1/credits/route.ts Param
Get usage
GET /api/v1/usage Use this endpoint to get usage. Endpoint Method: GET Path: /api/v1/usage Required scope: usage:read Base URL: https://dokki.one Route source: app/api/v1/usage/route.ts Parameters No
Create publication
POST /api/v1/resources/{resource_id}/publish Use this endpoint to create publication. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/publish Required scope: publish:write Base URL: https:
Delete publication
DELETE /api/v1/resources/{resource_id}/publish Use this endpoint to delete publication. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/publish Required scope: publish:write Base URL: ht
Get usage
GET /api/v1/storage/usage Use this endpoint to get usage. Endpoint Method: GET Path: /api/v1/storage/usage Required scope: storage:read Base URL: https://dokki.one Route source: app/api/v1/storage/usa
Get models
GET /api/v1/models Use this endpoint to get models. Endpoint Method: GET Path: /api/v1/models Required scope: model:read Base URL: https://dokki.one Route source: app/api/v1/models/route.ts Parameters
Update settings
PATCH /api/v1/usage/settings Use this endpoint to update settings. Endpoint Method: PATCH Path: /api/v1/usage/settings Required scope: usage:write Base URL: https://dokki.one Route source: app/api/v1/
Get publish status
GET /api/v1/resources/{resource_id}/publish Use this endpoint to get publish status. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/publish Required scope: publish:read Base URL: https://d
List trash
GET /api/v1/workspaces/{workspace_id}/trash Use this endpoint to list trash. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/trash Required scope: trash:read Base URL: https://dokki.one R
Add member
POST /api/v1/workspaces/{workspace_id}/members Use this endpoint to add member. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/members Required scope: member:write Base URL: https://dok
Empty trash
DELETE /api/v1/workspaces/{workspace_id}/trash Use this endpoint to empty trash. Endpoint Method: DELETE Path: /api/v1/workspaces/{workspace_id}/trash Required scope: trash:write Base URL: https://dok
Update publication
PATCH /api/v1/workspaces/{workspace_id}/publish Use this endpoint to update publication. Endpoint Method: PATCH Path: /api/v1/workspaces/{workspace_id}/publish Required scope: publish:write Base URL:
Remove member
DELETE /api/v1/workspaces/{workspace_id}/members/{member_id} Use this endpoint to remove member. Endpoint Method: DELETE Path: /api/v1/workspaces/{workspace_id}/members/{member_id} Required scope: mem
Update member
PATCH /api/v1/workspaces/{workspace_id}/members/{member_id} Use this endpoint to update member. Endpoint Method: PATCH Path: /api/v1/workspaces/{workspace_id}/members/{member_id} Required scope: membe
Create publication
POST /api/v1/workspaces/{workspace_id}/publish Use this endpoint to create publication. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/publish Required scope: publish:write Base URL: ht
Get publish status
GET /api/v1/workspaces/{workspace_id}/publish Use this endpoint to get publish status. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/publish Required scope: publish:read Base URL: https
List members
GET /api/v1/workspaces/{workspace_id}/members Use this endpoint to list members. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/members Required scope: member:read Base URL: https://dokk
Remove pin
DELETE /api/v1/workspaces/{workspace_id}/pins Use this endpoint to remove pin. Endpoint Method: DELETE Path: /api/v1/workspaces/{workspace_id}/pins Required scope: pin:write Base URL: https://dokki.on
Add pin
POST /api/v1/workspaces/{workspace_id}/pins Use this endpoint to add pin. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/pins Required scope: pin:write Base URL: https://dokki.one Route
Update pin
PATCH /api/v1/workspaces/{workspace_id}/pins Use this endpoint to update pin. Endpoint Method: PATCH Path: /api/v1/workspaces/{workspace_id}/pins Required scope: pin:write Base URL: https://dokki.one
Get connections
GET /api/v1/workspaces/{workspace_id}/connections Use this endpoint to get connections. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/connections Required scope: connection:read Base UR
List pins
GET /api/v1/workspaces/{workspace_id}/pins Use this endpoint to list pins. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/pins Required scope: pin:read Base URL: https://dokki.one Route
Delete connections
DELETE /api/v1/workspaces/{workspace_id}/connections/{connection_id} Use this endpoint to delete connections. Endpoint Method: DELETE Path: /api/v1/workspaces/{workspace_id}/connections/{connection_id
Delete connectors
DELETE /api/v1/workspaces/{workspace_id}/connectors/{connector_id} Use this endpoint to delete connectors. Endpoint Method: DELETE Path: /api/v1/workspaces/{workspace_id}/connectors/{connector_id} Req
Create connectors
POST /api/v1/workspaces/{workspace_id}/connectors Use this endpoint to create connectors. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/connectors Required scope: connector:write Base
Get connectors
GET /api/v1/workspaces/{workspace_id}/connectors Use this endpoint to get connectors. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/connectors Required scope: connector:read Base URL: h
Get workspaces
GET /api/v1/workspaces/{workspace_id} Use this endpoint to get workspaces. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id} Required scope: workspace:read Base URL: https://dokki.one Route
Create archive
POST /api/v1/workspaces/{workspace_id}/archive Use this endpoint to create archive. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/archive Required scope: workspace:write Base URL: http
Get workspaces
GET /api/v1/workspaces Use this endpoint to get workspaces. Endpoint Method: GET Path: /api/v1/workspaces Required scope: workspace:read Base URL: https://dokki.one Route source: app/api/v1/workspaces
Update workspaces
PATCH /api/v1/workspaces/{workspace_id} Use this endpoint to update workspaces. Endpoint Method: PATCH Path: /api/v1/workspaces/{workspace_id} Required scope: workspace:write Base URL: https://dokki.o
Create workspaces
POST /api/v1/workspaces Use this endpoint to create workspaces. Endpoint Method: POST Path: /api/v1/workspaces Required scope: workspace:write Base URL: https://dokki.one Route source: app/api/v1/work
Add member
POST /api/v1/orgs/{org_id}/members Use this endpoint to add member. Endpoint Method: POST Path: /api/v1/orgs/{org_id}/members Required scope: org_member:write Base URL: https://dokki.one Route source:
Remove member
DELETE /api/v1/orgs/{org_id}/members/{member_id} Use this endpoint to remove member. Endpoint Method: DELETE Path: /api/v1/orgs/{org_id}/members/{member_id} Required scope: org_member:write Base URL:
Update member
PATCH /api/v1/orgs/{org_id}/members/{member_id} Use this endpoint to update member. Endpoint Method: PATCH Path: /api/v1/orgs/{org_id}/members/{member_id} Required scope: org_member:write Base URL: ht
List members
GET /api/v1/orgs/{org_id}/members Use this endpoint to list members. Endpoint Method: GET Path: /api/v1/orgs/{org_id}/members Required scope: org_member:read Base URL: https://dokki.one Route source:
Get orgs
GET /api/v1/orgs Use this endpoint to get orgs. Endpoint Method: GET Path: /api/v1/orgs Required scope: org:read Base URL: https://dokki.one Route source: app/api/v1/orgs/route.ts Parameters No path p
Get orgs
GET /api/v1/orgs/{org_id} Use this endpoint to get orgs. Endpoint Method: GET Path: /api/v1/orgs/{org_id} Required scope: org:read Base URL: https://dokki.one Route source: app/api/v1/orgs/[orgId]/rou
Delete orgs
DELETE /api/v1/orgs/{org_id} Use this endpoint to delete orgs. Endpoint Method: DELETE Path: /api/v1/orgs/{org_id} Required scope: org:write Base URL: https://dokki.one Route source: app/api/v1/orgs/[
Create orgs
POST /api/v1/orgs Use this endpoint to create orgs. Endpoint Method: POST Path: /api/v1/orgs Required scope: org:write Base URL: https://dokki.one Route source: app/api/v1/orgs/route.ts Parameters No
Update orgs
PATCH /api/v1/orgs/{org_id} Use this endpoint to update orgs. Endpoint Method: PATCH Path: /api/v1/orgs/{org_id} Required scope: org:write Base URL: https://dokki.one Route source: app/api/v1/orgs/[or
Update chat sessions
PATCH /api/v1/chat-sessions/{session_id} Use this endpoint to update chat sessions. Endpoint Method: PATCH Path: /api/v1/chat-sessions/{session_id} Required scope: chat_session:write Base URL: https:/
Create chat sessions
POST /api/v1/chat-sessions Use this endpoint to create chat sessions. Endpoint Method: POST Path: /api/v1/chat-sessions Required scope: chat_session:write Base URL: https://dokki.one Route source: app
Get access requests
GET /api/v1/resources/{resource_id}/access-requests Use this endpoint to get access requests. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/access-requests Required scope: access_request:
Replace chat sessions
PUT /api/v1/chat-sessions/{session_id} Use this endpoint to replace chat sessions. Endpoint Method: PUT Path: /api/v1/chat-sessions/{session_id} Required scope: chat_session:write Base URL: https://do
Delete chat sessions
DELETE /api/v1/chat-sessions/{session_id} Use this endpoint to delete chat sessions. Endpoint Method: DELETE Path: /api/v1/chat-sessions/{session_id} Required scope: chat_session:write Base URL: https
Get chat sessions
GET /api/v1/chat-sessions/{session_id} Use this endpoint to get chat sessions. Endpoint Method: GET Path: /api/v1/chat-sessions/{session_id} Required scope: chat_session:read Base URL: https://dokki.o
Create access requests
POST /api/v1/resources/{resource_id}/access-requests Use this endpoint to create access requests. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/access-requests Required scope: access_req
Get chat sessions
GET /api/v1/chat-sessions Use this endpoint to get chat sessions. Endpoint Method: GET Path: /api/v1/chat-sessions Required scope: chat_session:read Base URL: https://dokki.one Route source: app/api/v
Get conversations
GET /api/v1/im/conversations/{conversation_id} Use this endpoint to get conversations. Endpoint Method: GET Path: /api/v1/im/conversations/{conversation_id} Required scope: im:read Base URL: https://d
Update conversations
PATCH /api/v1/im/conversations/{conversation_id} Use this endpoint to update conversations. Endpoint Method: PATCH Path: /api/v1/im/conversations/{conversation_id} Required scope: im:write Base URL: h
Send message
POST /api/v1/im/conversations/{conversation_id}/messages Use this endpoint to send message. Endpoint Method: POST Path: /api/v1/im/conversations/{conversation_id}/messages Required scope: im:write Bas
Add member
POST /api/v1/im/conversations/{conversation_id}/members Use this endpoint to add member. Endpoint Method: POST Path: /api/v1/im/conversations/{conversation_id}/members Required scope: im:write Base UR
Update settings
PATCH /api/v1/im/conversations/{conversation_id}/settings Use this endpoint to update settings. Endpoint Method: PATCH Path: /api/v1/im/conversations/{conversation_id}/settings Required scope: im:writ
Mark conversation read
POST /api/v1/im/conversations/{conversation_id}/read Use this endpoint to mark conversation read. Endpoint Method: POST Path: /api/v1/im/conversations/{conversation_id}/read Required scope: im:write B
List messages
GET /api/v1/im/conversations/{conversation_id}/messages Use this endpoint to list messages. Endpoint Method: GET Path: /api/v1/im/conversations/{conversation_id}/messages Required scope: im:read Base
Delete conversations
DELETE /api/v1/im/conversations/{conversation_id} Use this endpoint to delete conversations. Endpoint Method: DELETE Path: /api/v1/im/conversations/{conversation_id} Required scope: im:write Base URL:
Update access requests
PATCH /api/v1/access-requests/{request_id} Use this endpoint to update access requests. Endpoint Method: PATCH Path: /api/v1/access-requests/{request_id} Required scope: access_request:write Base URL:
Update memories
PATCH /api/v1/memories/{memory_id} Use this endpoint to update memories. Endpoint Method: PATCH Path: /api/v1/memories/{memory_id} Required scope: memory:write Base URL: https://dokki.one Route source
Get work items
GET /api/v1/work-items/{work_item_id} Use this endpoint to get work items. Endpoint Method: GET Path: /api/v1/work-items/{work_item_id} Required scope: work_item:read Base URL: https://dokki.one Route
Create conversations
POST /api/v1/im/conversations Use this endpoint to create conversations. Endpoint Method: POST Path: /api/v1/im/conversations Required scope: im:write Base URL: https://dokki.one Route source: app/api
Delete work items
DELETE /api/v1/work-items/{work_item_id} Use this endpoint to delete work items. Endpoint Method: DELETE Path: /api/v1/work-items/{work_item_id} Required scope: work_item:write Base URL: https://dokki
Delete memories
DELETE /api/v1/memories/{memory_id} Use this endpoint to delete memories. Endpoint Method: DELETE Path: /api/v1/memories/{memory_id} Required scope: memory:write Base URL: https://dokki.one Route sour
Get conversations
GET /api/v1/im/conversations Use this endpoint to get conversations. Endpoint Method: GET Path: /api/v1/im/conversations Required scope: im:read Base URL: https://dokki.one Route source: app/api/v1/im
Update work items
PATCH /api/v1/work-items/{work_item_id} Use this endpoint to update work items. Endpoint Method: PATCH Path: /api/v1/work-items/{work_item_id} Required scope: work_item:write Base URL: https://dokki.o
Get memories
GET /api/v1/memories/{memory_id} Use this endpoint to get memories. Endpoint Method: GET Path: /api/v1/memories/{memory_id} Required scope: memory:read Base URL: https://dokki.one Route source: app/ap
Get automations
GET /api/v1/automations/{automation_id} Use this endpoint to get automations. Endpoint Method: GET Path: /api/v1/automations/{automation_id} Required scope: automation:read Base URL: https://dokki.one
Create memories
POST /api/v1/memories Use this endpoint to create memories. Endpoint Method: POST Path: /api/v1/memories Required scope: memory:write Base URL: https://dokki.one Route source: app/api/v1/memories/rout
Run automation
POST /api/v1/automations/{automation_id}/run Use this endpoint to run automation. Endpoint Method: POST Path: /api/v1/automations/{automation_id}/run Required scope: automation:write Base URL: https:/
Delete automations
DELETE /api/v1/automations/{automation_id} Use this endpoint to delete automations. Endpoint Method: DELETE Path: /api/v1/automations/{automation_id} Required scope: automation:write Base URL: https:/
Get memories
GET /api/v1/memories Use this endpoint to get memories. Endpoint Method: GET Path: /api/v1/memories Required scope: memory:read Base URL: https://dokki.one Route source: app/api/v1/memories/route.ts P
Update automations
PATCH /api/v1/automations/{automation_id} Use this endpoint to update automations. Endpoint Method: PATCH Path: /api/v1/automations/{automation_id} Required scope: automation:write Base URL: https://d
List runs
GET /api/v1/automations/{automation_id}/runs Use this endpoint to list runs. Endpoint Method: GET Path: /api/v1/automations/{automation_id}/runs Required scope: automation:read Base URL: https://dokki
Delete agent schedules
DELETE /api/v1/agent-schedules/{schedule_id} Use this endpoint to delete agent schedules. Endpoint Method: DELETE Path: /api/v1/agent-schedules/{schedule_id} Required scope: agent_schedule:write Base
Get agent schedules
GET /api/v1/agent-schedules/{schedule_id} Use this endpoint to get agent schedules. Endpoint Method: GET Path: /api/v1/agent-schedules/{schedule_id} Required scope: agent_schedule:read Base URL: https
Update agent schedules
PATCH /api/v1/agent-schedules/{schedule_id} Use this endpoint to update agent schedules. Endpoint Method: PATCH Path: /api/v1/agent-schedules/{schedule_id} Required scope: agent_schedule:write Base UR
Create agent schedules
POST /api/v1/agent-schedules Use this endpoint to create agent schedules. Endpoint Method: POST Path: /api/v1/agent-schedules Required scope: agent_schedule:write Base URL: https://dokki.one Route sou
Update agent approvals
PATCH /api/v1/agent-approvals/{approval_id} Use this endpoint to update agent approvals. Endpoint Method: PATCH Path: /api/v1/agent-approvals/{approval_id} Required scope: agent_approval:write Base UR
Get agent schedules
GET /api/v1/agent-schedules Use this endpoint to get agent schedules. Endpoint Method: GET Path: /api/v1/agent-schedules Required scope: agent_schedule:read Base URL: https://dokki.one Route source: a
Get automations
GET /api/v1/automations Use this endpoint to get automations. Endpoint Method: GET Path: /api/v1/automations Required scope: automation:read Base URL: https://dokki.one Route source: app/api/v1/automa
Create automations
POST /api/v1/automations Use this endpoint to create automations. Endpoint Method: POST Path: /api/v1/automations Required scope: automation:write Base URL: https://dokki.one Route source: app/api/v1/
Get agent approvals
GET /api/v1/agent-approvals Use this endpoint to get agent approvals. Endpoint Method: GET Path: /api/v1/agent-approvals Required scope: agent_approval:read Base URL: https://dokki.one Route source: a
Get agent approvals
GET /api/v1/agent-approvals/{approval_id} Use this endpoint to get agent approvals. Endpoint Method: GET Path: /api/v1/agent-approvals/{approval_id} Required scope: agent_approval:read Base URL: https
Get agent runs
GET /api/v1/agent-runs/{run_id} Use this endpoint to get agent runs. Endpoint Method: GET Path: /api/v1/agent-runs/{run_id} Required scope: agent_run:read Base URL: https://dokki.one Route source: app
Cancel run
POST /api/v1/agent-runs/{run_id}/cancel Use this endpoint to cancel run. Endpoint Method: POST Path: /api/v1/agent-runs/{run_id}/cancel Required scope: agent_run:write Base URL: https://dokki.one Rout
Update mcp
PATCH /api/v1/agents/{agent_id}/mcp Use this endpoint to update mcp. Endpoint Method: PATCH Path: /api/v1/agents/{agent_id}/mcp Required scope: agent:write Base URL: https://dokki.one Route source: ap
Create agent runs
POST /api/v1/agent-runs Use this endpoint to create agent runs. Endpoint Method: POST Path: /api/v1/agent-runs Required scope: agent_run:write Base URL: https://dokki.one Route source: app/api/v1/agen
Create mcp
POST /api/v1/agents/{agent_id}/mcp Use this endpoint to create mcp. Endpoint Method: POST Path: /api/v1/agents/{agent_id}/mcp Required scope: agent:write Base URL: https://dokki.one Route source: app/
Get agent runs
GET /api/v1/agent-runs Use this endpoint to get agent runs. Endpoint Method: GET Path: /api/v1/agent-runs Required scope: agent_run:read Base URL: https://dokki.one Route source: app/api/v1/agent-runs
Get mcp
GET /api/v1/agents/{agent_id}/mcp Use this endpoint to get mcp. Endpoint Method: GET Path: /api/v1/agents/{agent_id}/mcp Required scope: agent:read Base URL: https://dokki.one Route source: app/api/v1
Delete mcp
DELETE /api/v1/agents/{agent_id}/mcp Use this endpoint to delete mcp. Endpoint Method: DELETE Path: /api/v1/agents/{agent_id}/mcp Required scope: agent:write Base URL: https://dokki.one Route source:
Get skills
GET /api/v1/agents/{agent_id}/skills Use this endpoint to get skills. Endpoint Method: GET Path: /api/v1/agents/{agent_id}/skills Required scope: agent:read Base URL: https://dokki.one Route source: a
Replace skills
PUT /api/v1/agents/{agent_id}/skills Use this endpoint to replace skills. Endpoint Method: PUT Path: /api/v1/agents/{agent_id}/skills Required scope: agent:write Base URL: https://dokki.one Route sour
Get memories
GET /api/v1/agents/{agent_id}/memories Use this endpoint to get memories. Endpoint Method: GET Path: /api/v1/agents/{agent_id}/memories Required scope: agent:read Base URL: https://dokki.one Route sou
Delete memories
DELETE /api/v1/agents/{agent_id}/memories Use this endpoint to delete memories. Endpoint Method: DELETE Path: /api/v1/agents/{agent_id}/memories Required scope: agent:write Base URL: https://dokki.one
Replace workspaces
PUT /api/v1/agents/{agent_id}/workspaces Use this endpoint to replace workspaces. Endpoint Method: PUT Path: /api/v1/agents/{agent_id}/workspaces Required scope: agent:write Base URL: https://dokki.on
Create memories
POST /api/v1/agents/{agent_id}/memories Use this endpoint to create memories. Endpoint Method: POST Path: /api/v1/agents/{agent_id}/memories Required scope: agent:write Base URL: https://dokki.one Rou
Remove pin
DELETE /api/v1/agents/{agent_id}/pins Use this endpoint to remove pin. Endpoint Method: DELETE Path: /api/v1/agents/{agent_id}/pins Required scope: agent:write Base URL: https://dokki.one Route source
Update agents
PATCH /api/v1/agents/{agent_id} Use this endpoint to update agents. Endpoint Method: PATCH Path: /api/v1/agents/{agent_id} Required scope: agent:write Base URL: https://dokki.one Route source: app/api
Get workspaces
GET /api/v1/agents/{agent_id}/workspaces Use this endpoint to get workspaces. Endpoint Method: GET Path: /api/v1/agents/{agent_id}/workspaces Required scope: agent:read Base URL: https://dokki.one Rou
Update pin
PATCH /api/v1/agents/{agent_id}/pins Use this endpoint to update pin. Endpoint Method: PATCH Path: /api/v1/agents/{agent_id}/pins Required scope: agent:write Base URL: https://dokki.one Route source:
Delete agents
DELETE /api/v1/agents/{agent_id} Use this endpoint to delete agents. Endpoint Method: DELETE Path: /api/v1/agents/{agent_id} Required scope: agent:write Base URL: https://dokki.one Route source: app/a
Add pin
POST /api/v1/agents/{agent_id}/pins Use this endpoint to add pin. Endpoint Method: POST Path: /api/v1/agents/{agent_id}/pins Required scope: agent:write Base URL: https://dokki.one Route source: app/a
List pins
GET /api/v1/agents/{agent_id}/pins Use this endpoint to list pins. Endpoint Method: GET Path: /api/v1/agents/{agent_id}/pins Required scope: agent:read Base URL: https://dokki.one Route source: app/ap
Get agents
GET /api/v1/agents/{agent_id} Use this endpoint to get agents. Endpoint Method: GET Path: /api/v1/agents/{agent_id} Required scope: agent:read Base URL: https://dokki.one Route source: app/api/v1/agen
Get agents
GET /api/v1/agents Use this endpoint to get agents. Endpoint Method: GET Path: /api/v1/agents Required scope: agent:read Base URL: https://dokki.one Route source: app/api/v1/agents/route.ts Parameters
Create agents
POST /api/v1/agents Use this endpoint to create agents. Endpoint Method: POST Path: /api/v1/agents Required scope: agent:write Base URL: https://dokki.one Route source: app/api/v1/agents/route.ts Para
Create work items
POST /api/v1/work-items Use this endpoint to create work items. Endpoint Method: POST Path: /api/v1/work-items Required scope: work_item:write Base URL: https://dokki.one Route source: app/api/v1/work
Get work items
GET /api/v1/work-items Use this endpoint to get work items. Endpoint Method: GET Path: /api/v1/work-items Required scope: work_item:read Base URL: https://dokki.one Route source: app/api/v1/work-items
Remove tag
PATCH /api/v1/tags/{tag_id} Use this endpoint to remove tag. Endpoint Method: PATCH Path: /api/v1/tags/{tag_id} Required scope: tag:write Base URL: https://dokki.one Route source: app/api/v1/tags/[tag
Remove tag
DELETE /api/v1/tags/{tag_id} Use this endpoint to remove tag. Endpoint Method: DELETE Path: /api/v1/tags/{tag_id} Required scope: tag:write Base URL: https://dokki.one Route source: app/api/v1/tags/[t
Create search
POST /api/v1/search Use this endpoint to create search. Endpoint Method: POST Path: /api/v1/search Required scope: search:read Base URL: https://dokki.one Route source: app/api/v1/search/route.ts Para
Remove tag
DELETE /api/v1/resources/{resource_id}/tags Use this endpoint to remove tag. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/tags Required scope: tag:write Base URL: https://dokki.one Ro
Revoke permission
DELETE /api/v1/resources/{resource_id}/permissions Use this endpoint to revoke permission. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/permissions Required scope: share:write Base UR
Create snapshot
DELETE /api/v1/resources/{resource_id}/snapshots/{snapshot_id} Use this endpoint to create snapshot. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/snapshots/{snapshot_id} Required scop
List snapshots
GET /api/v1/resources/{resource_id}/snapshots Use this endpoint to list snapshots. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/snapshots Required scope: snapshot:read Base URL: https://
Add tag
POST /api/v1/resources/{resource_id}/tags Use this endpoint to add tag. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/tags Required scope: tag:write Base URL: https://dokki.one Route sou
Grant permission
POST /api/v1/resources/{resource_id}/permissions Use this endpoint to grant permission. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/permissions Required scope: share:write Base URL: ht
Get permissions
GET /api/v1/resources/{resource_id}/permissions Use this endpoint to get permissions. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/permissions Required scope: resource:read Base URL: htt
Create snapshot
POST /api/v1/resources/{resource_id}/snapshots Use this endpoint to create snapshot. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/snapshots Required scope: snapshot:write Base URL: http
List snapshots
GET /api/v1/resources/{resource_id}/snapshots/{snapshot_id} Use this endpoint to list snapshots. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/snapshots/{snapshot_id} Required scope: snap
Delete {comment_id}
DELETE /api/v1/resources/{resource_id}/comments/{comment_id} Use this endpoint to delete {comment_id}. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/comments/{comment_id} Required scop
Update content
PATCH /api/v1/resources/{resource_id}/content Use this endpoint to update content. Endpoint Method: PATCH Path: /api/v1/resources/{resource_id}/content Required scope: content:write Base URL: https://
List resource tags
GET /api/v1/resources/{resource_id}/tags Use this endpoint to list resource tags. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/tags Required scope: tag:read Base URL: https://dokki.one R
List comments
GET /api/v1/resources/{resource_id}/comments Use this endpoint to list comments. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/comments Required scope: comment:read Base URL: https://dokk
Delete form
DELETE /api/v1/resources/{resource_id}/form Use this endpoint to delete form. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id}/form Required scope: form:write Base URL: https://dokki.one
Update {comment_id}
PATCH /api/v1/resources/{resource_id}/comments/{comment_id} Use this endpoint to update {comment_id}. Endpoint Method: PATCH Path: /api/v1/resources/{resource_id}/comments/{comment_id} Required scope:
Update form
PATCH /api/v1/resources/{resource_id}/form Use this endpoint to update form. Endpoint Method: PATCH Path: /api/v1/resources/{resource_id}/form Required scope: form:write Base URL: https://dokki.one Ro
Create comments
POST /api/v1/resources/{resource_id}/comments Use this endpoint to create comments. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/comments Required scope: comment:write Base URL: https:/
Create form
POST /api/v1/resources/{resource_id}/form Use this endpoint to create form. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/form Required scope: form:write Base URL: https://dokki.one Rout
Get file
GET /api/v1/resources/{resource_id}/file Use this endpoint to get file. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/file Required scope: file:read Base URL: https://dokki.one Route sour
Get form
GET /api/v1/resources/{resource_id}/form Use this endpoint to get form. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/form Required scope: form:read Base URL: https://dokki.one Route sour
Create restore
POST /api/v1/resources/{resource_id}/restore Use this endpoint to create restore. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/restore Required scope: trash:write Base URL: https://dokk
Get content
GET /api/v1/resources/{resource_id}/content Use this endpoint to get content. Endpoint Method: GET Path: /api/v1/resources/{resource_id}/content Required scope: content:read Base URL: https://dokki.on
Update {resource_id}
PATCH /api/v1/resources/{resource_id} Use this endpoint to update {resource_id}. Endpoint Method: PATCH Path: /api/v1/resources/{resource_id} Required scope: resource:write Base URL: https://dokki.one
Create copy
POST /api/v1/resources/{resource_id}/copy Use this endpoint to create copy. Endpoint Method: POST Path: /api/v1/resources/{resource_id}/copy Required scope: resource:write Base URL: https://dokki.one
Delete {resource_id}
DELETE /api/v1/resources/{resource_id} Use this endpoint to delete {resource_id}. Endpoint Method: DELETE Path: /api/v1/resources/{resource_id} Required scope: resource:write Base URL: https://dokki.o
Get imports
GET /api/v1/imports/{import_id} Use this endpoint to get imports. Endpoint Method: GET Path: /api/v1/imports/{import_id} Required scope: import:read Base URL: https://dokki.one Route source: app/api/v
List resource tags
POST /api/v1/workspaces/{workspace_id}/tags Use this endpoint to list resource tags. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/tags Required scope: tag:write Base URL: https://dokk
Create imports
POST /api/v1/workspaces/{workspace_id}/imports Use this endpoint to create imports. Endpoint Method: POST Path: /api/v1/workspaces/{workspace_id}/imports Required scope: import:write Base URL: https:/
Get resource
GET /api/v1/workspaces/{workspace_id}/resources Use this endpoint to get resource. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/resources Required scope: resource:read Base URL: https:
Get {resource_id}
GET /api/v1/resources/{resource_id} Use this endpoint to get {resource_id}. Endpoint Method: GET Path: /api/v1/resources/{resource_id} Required scope: resource:read Base URL: https://dokki.one Route s
Retry import
POST /api/v1/imports/{import_id}/retry Use this endpoint to retry import. Endpoint Method: POST Path: /api/v1/imports/{import_id}/retry Required scope: import:write Base URL: https://dokki.one Route s
Delete imports
DELETE /api/v1/imports/{import_id} Use this endpoint to delete imports. Endpoint Method: DELETE Path: /api/v1/imports/{import_id} Required scope: import:write Base URL: https://dokki.one Route source:
List resource tags
GET /api/v1/workspaces/{workspace_id}/tags Use this endpoint to list resource tags. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/tags Required scope: tag:read Base URL: https://dokki.o
Create resources
POST /api/v1/resources Use this endpoint to create resources. Endpoint Method: POST Path: /api/v1/resources Required scope: resource:write Base URL: https://dokki.one Route source: app/api/v1/resource
Delete workspace templates
DELETE /api/v1/workspace-templates/{template_id} Use this endpoint to delete workspace templates. Endpoint Method: DELETE Path: /api/v1/workspace-templates/{template_id} Required scope: workspace_temp
Get workspace templates
GET /api/v1/workspace-templates/{template_id} Use this endpoint to get workspace templates. Endpoint Method: GET Path: /api/v1/workspace-templates/{template_id} Required scope: workspace_template:read
Get workspace templates
GET /api/v1/workspace-templates Use this endpoint to get workspace templates. Endpoint Method: GET Path: /api/v1/workspace-templates Required scope: workspace_template:read Base URL: https://dokki.one
Get imports
GET /api/v1/workspaces/{workspace_id}/imports Use this endpoint to get imports. Endpoint Method: GET Path: /api/v1/workspaces/{workspace_id}/imports Required scope: import:read Base URL: https://dokki
Create workspace templates
POST /api/v1/workspace-templates Use this endpoint to create workspace templates. Endpoint Method: POST Path: /api/v1/workspace-templates Required scope: workspace_template:write Base URL: https://dok
Create files
POST /api/v1/files Use this endpoint to create files. Endpoint Method: POST Path: /api/v1/files Required scope: file:write Base URL: https://dokki.one Route source: app/api/v1/files/route.ts Parameter
Create submit
POST /api/v1/forms/{token}/submit Use this endpoint to create submit. Endpoint Method: POST Path: /api/v1/forms/{token}/submit Required scope: form:submit Base URL: https://dokki.one Route source: app
Delete notifications
DELETE /api/v1/notifications Use this endpoint to delete notifications. Endpoint Method: DELETE Path: /api/v1/notifications Required scope: notification:write Base URL: https://dokki.one Route source:
Update notifications
PATCH /api/v1/notifications Use this endpoint to update notifications. Endpoint Method: PATCH Path: /api/v1/notifications Required scope: notification:write Base URL: https://dokki.one Route source: a
Get notifications
GET /api/v1/notifications Use this endpoint to get notifications. Endpoint Method: GET Path: /api/v1/notifications Required scope: notification:read Base URL: https://dokki.one Route source: app/api/v
List API capabilities
GET /api/v1/capabilities Use this endpoint to list api capabilities. Endpoint Method: GET Path: /api/v1/capabilities Required scope: none Base URL: https://dokki.one Route source: app/api/v1/capabilit
Create api keys
POST /api/v1/api-keys Use this endpoint to create api keys. Endpoint Method: POST Path: /api/v1/api-keys Required scope: api_key:write Base URL: https://dokki.one Route source: app/api/v1/api-keys/rou
Get current user
GET /api/v1/me Use this endpoint to get current user. Endpoint Method: GET Path: /api/v1/me Required scope: none Base URL: https://dokki.one Route source: app/api/v1/me/route.ts Parameters No path par
Delete api keys
DELETE /api/v1/api-keys/{key_id} Use this endpoint to delete api keys. Endpoint Method: DELETE Path: /api/v1/api-keys/{key_id} Required scope: api_key:write Base URL: https://dokki.one Route source: a
Get api keys
GET /api/v1/api-keys Use this endpoint to get api keys. Endpoint Method: GET Path: /api/v1/api-keys Required scope: api_key:read Base URL: https://dokki.one Route source: app/api/v1/api-keys/route.ts
API Documentation Home
Dokki API Build with Dokki's documents, tables, artifacts, search, agents, and organization controls. The Dokki API is the programmatic interface to the same resources and permissions used by the Dokk
Changelog
API Changelog This page records externally visible API changes. 2026-07-10 Added the public API endpoint catalog under /api/v1 . Added API key scope persistence and capability filtering. Added initial
Documentation Maintenance and SEO/GEO Rules
Documentation Maintenance and SEO/GEO Rules This page defines how the Dokki API documentation stays useful to developers, search engines, and AI answer engines. One page, one intent Each page should a
Production Checklist
Production API Checklist Before shipping an integration: Create a dedicated API key with the smallest scope set. Verify GET /api/v1/me and tenant identity. Discover /api/v1/capabilities . Test one rea
Integration Patterns
Integration Patterns Read-only indexer Use workspace:read , resource:read , content:read , and search:read . Store resource ids and updated timestamps. Re-index only changed content. Content synchroni
Usage, Credits, and Storage
Usage, Credits, and Storage Account endpoints expose usage, credits, model availability, storage, notifications, and API key management. Use these endpoints to build an integration health page: GET /a
Files and Imports
Files and Imports Files are uploaded resources with signed download URLs. Imports are asynchronous operations that may create or update workspace resources. Use the file endpoint for short-lived downl
Publishing and Custom Domains
Publishing and Custom Domains Publishing exposes selected Dokki content to readers outside the authenticated workspace. Publish safely Create or inspect the workspace published site. Set a stable slug
Organizations and Members
Organizations and Members Organizations group workspaces and establish the tenant boundary for Org API keys. Use: GET /api/v1/orgs to discover accessible Orgs. GET /api/v1/orgs/{org_id} for settings.
Chat Sessions and Messaging
Chat Sessions and Messaging Chat sessions are durable conversation containers. Create a session with a workspace or Org context, then read or update it through its session id. Messages are stored as s
Comments, Sharing, and Permissions
Comments, Sharing, and Permissions Comments are attached to document resources. Sharing changes the effective object permission and should be treated as an access-control operation. Safe share flow Re
Automations and Schedules
Automations and Schedules Automations are workspace-scoped handlers. Schedules determine when agent or automation work starts. Use GET /api/v1/automations?workspace_id=... and GET /api/v1/agent-schedu
Agents, Runs, and Approvals
Agents, Runs, and Approvals Agents are user-owned automation identities with optional workspace access, skills, memories, and external MCP servers. Agent lifecycle List agents with GET /api/v1/agents
Search and Knowledge Graph
Search and Knowledge Graph Use POST /api/v1/search for keyword, semantic, or hybrid search. { "query": "permission model", "mode": "hybrid", "workspace_ids": ["workspace_uuid"], "limit": 20 } Search r
Tables and Artifacts
Tables and Artifacts Tables and artifacts share the resource permission model but use different content shapes. Tables A table write supplies non-empty columns and a rows array. Column ids should be s
Document Content and Versions
Document Content and Versions Use GET /api/v1/resources/{resource_id}/content to read content and PATCH to replace it. Use the snapshots endpoints to create and list recovery points. Recommended write
Resources and Workspaces
Resources and Workspaces A workspace is a tenant-local container. Resources are documents, tables, artifacts, folders, and files arranged in a tree. Common flow GET /api/v1/workspaces GET /api/v1/work
Capabilities and Feature Discovery
Capabilities and Feature Discovery Call GET /api/v1/capabilities at startup and cache the result for a short period. The response includes: API version and preview status. Scopes available to the call
API Conventions
API Conventions URL and methods All public endpoints use https://dokki.one/api/v1 . GET : read. POST : create or trigger an operation. PATCH : partial update. PUT : replace a relationship or configura
Pagination, Errors, and Rate Limits
Pagination, Errors, and Rate Limits Pagination Most list endpoints accept: limit : number of items, bounded by the server. offset : zero-based offset. Responses include a page object when the endpoint
Permissions and Organization Access
Permissions and Organization Access Every request passes three gates: Token scope. Tenant boundary: Personal, Org, and optionally workspace context. Object permission: resource role, workspace role, O
Create and Update a Document
Create and Update a Document Create curl -X POST https://dokki.one/api/v1/resources \ -H "Authorization: Bearer $DOKKI_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "document", "name"
Quickstart: First Request
Quickstart: First Request This guide gets a backend integration from zero to a verified Dokki request. 1. Set the secret export DOKKI_API_KEY="dk_..." 2. Verify authentication curl -sS https://dokki.o
API Keys and Scopes
API Keys and Scopes API keys are tenant-bound credentials. A Personal key is limited to Personal workspaces. An Org key is limited to that Org. Create a key Use the Dokki account API key manager or: P
Authentication
Authentication Dokki API supports browser sessions, Supabase bearer tokens, and Dokki API keys. Server-to-server integrations should use an API key created by an administrator. Send a bearer token cur