Skip to content
Covo Developers

Reference

API reference

Every operation, available as a REST endpoint and as an MCP tool with the same name, inputs and rules.

Each operation below is one REST endpoint and one MCP tool. The classification follows Meta Muse: Read changes nothing, Write changes data, and Sensitive write changes what visitors see or is hard to undo, so it needs confirm: true after the person agrees.

Account and discovery

OperationRESTClassificationScope
get_accountGET /api/v1/meReadany
list_workspacesGET /api/v1/workspacesReadany
list_agentsGET /api/v1/agentsReadany
get_agentGET /api/v1/agents/{agent_id}Readagents:read
get_configuration_schemaGET /api/v1/schema/configurationReadany

Inspect an agent

OperationRESTClassificationScope
get_agent_configurationGET /api/v1/agents/{agent_id}/configurationReadagents:read
list_knowledge_sourcesGET /api/v1/agents/{agent_id}/knowledge/sourcesReadagents:read
list_agent_toolsGET /api/v1/agents/{agent_id}/toolsReadagents:read
get_agent_activityGET /api/v1/agents/{agent_id}/activityReadagents:read

Change an agent

OperationRESTClassificationScope
preview_agent_changesPOST /api/v1/agents/{agent_id}/configuration/previewReadagents:read
update_agent_configurationPATCH /api/v1/agents/{agent_id}/configurationSensitive writeagents:write
import_knowledge_from_urlPOST /api/v1/agents/{agent_id}/knowledge/sourcesWriteagents:write

Drafts

OperationRESTClassificationScope
create_draftPOST /api/v1/agents/{agent_id}/draftsWriteagents:write
list_draftsGET /api/v1/agents/{agent_id}/draftsReadagents:read
get_draftGET /api/v1/agents/{agent_id}/drafts/{draft_id}Readagents:read
update_draftPATCH /api/v1/agents/{agent_id}/drafts/{draft_id}Writeagents:write
apply_draftPOST /api/v1/agents/{agent_id}/drafts/{draft_id}/applySensitive writeagents:write
discard_draftPOST /api/v1/agents/{agent_id}/drafts/{draft_id}/discardWriteagents:write

Versions and rollback

OperationRESTClassificationScope
list_versionsGET /api/v1/agents/{agent_id}/versionsReadagents:read
create_versionPOST /api/v1/agents/{agent_id}/versionsWriteagents:write
get_versionGET /api/v1/agents/{agent_id}/versions/{version}Readagents:read
diff_versionsGET /api/v1/agents/{agent_id}/diffReadagents:read
restore_versionPOST /api/v1/agents/{agent_id}/versions/{version}/restoreSensitive writeagents:publish

Validate and test

OperationRESTClassificationScope
validate_agentPOST /api/v1/agents/{agent_id}/validateReadagents:read
run_agent_testPOST /api/v1/agents/{agent_id}/testsWriteagents:test
list_test_runsGET /api/v1/agents/{agent_id}/testsReadagents:read
get_test_runGET /api/v1/agents/{agent_id}/tests/{test_run_id}Readagents:read
diagnose_agentGET /api/v1/agents/{agent_id}/diagnosticsReadagents:read

Deployment

OperationRESTClassificationScope
get_deployment_statusGET /api/v1/agents/{agent_id}/deploymentReadagents:read
publish_agentPOST /api/v1/agents/{agent_id}/publishSensitive writeagents:publish
unpublish_agentPOST /api/v1/agents/{agent_id}/unpublishSensitive writeagents:publish
OperationRESTClassificationScope
list_short_linksGET /api/v1/agents/{agent_id}/short-linksReadagents:read
create_short_linkPOST /api/v1/agents/{agent_id}/short-linksWriteagents:write
update_short_linkPATCH /api/v1/agents/{agent_id}/short-links/{short_link_id}Sensitive writeagents:write
delete_short_linkPOST /api/v1/agents/{agent_id}/short-links/{short_link_id}/deleteSensitive writeagents:write

Conversations

OperationRESTClassificationScope
list_conversationsGET /api/v1/agents/{agent_id}/conversationsReadconversations:read
get_conversationGET /api/v1/agents/{agent_id}/conversations/{conversation_id}Readconversations:read

Machine-readable

  • OpenAPI 3.1: /api/v1/openapi.json
  • MCP server: https://covo.lanaai.io/mcp (its tools/list carries the same schemas and annotations)
  • Everything as one text file for agents: /llms-full.txt