Coview agent API

Base URL:

https://api.coview.dev/v1/agent

Use POST https://api.coview.dev/v1/agent/{method} with a JSON body matching the method input schema.

If the page URL contains an id, that id is the document id to use. For example, in https://coview.dev/d/my-document-id, use documentId "my-document-id".

Machine-readable method catalog:

GET https://api.coview.dev/v1/agent

All direct agent API methods:

1. get_basic_info
URL: https://api.coview.dev/v1/agent/get_basic_info
Description: Return basic Acuarela document metadata and agent guidance. Acuarela is an agent-human collaboration canvas for designing with a human using web tools like HTML, canvas state, and MCP operations.
Input schema:
{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}
Body:
{}

2. create_document
URL: https://api.coview.dev/v1/agent/create_document
Description: Create a new Acuarela document and return its id and URLs.
Input schema:
{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}
Body:
{}

3. get_canvas_state
URL: https://api.coview.dev/v1/agent/get_canvas_state
Description: Return the current persisted Acuarela canvas store.
Input schema:
{
  "additionalProperties": false,
  "properties": {
    "documentId": { "type": "string" }
  },
  "required": ["documentId"],
  "type": "object"
}
Body:
{
  "documentId": "default"
}

4. apply_operations
URL: https://api.coview.dev/v1/agent/apply_operations
Description: Apply Acuarela operation batches to the current document.
Input schema:
{
  "additionalProperties": false,
  "properties": {
    "clientId": { "type": "string" },
    "documentId": { "type": "string" },
    "operations": { "type": "array" }
  },
  "required": ["documentId", "operations"],
  "type": "object"
}
Body:
{
  "documentId": "default",
  "clientId": "agent-client-id",
  "operations": []
}

Use real Acuarela operations in the operations array.

5. finish_working_on_nodes
URL: https://api.coview.dev/v1/agent/finish_working_on_nodes
Description: Return the final persisted document version after an MCP turn.
Input schema:
{
  "additionalProperties": false,
  "properties": {
    "documentId": { "type": "string" }
  },
  "required": ["documentId"],
  "type": "object"
}
Body:
{
  "documentId": "default"
}

Example direct read:

curl -s https://api.coview.dev/v1/agent/get_canvas_state \
  -H "content-type: application/json" \
  -d '{"documentId":"my-document-id"}'

Example direct edit:

curl -s https://api.coview.dev/v1/agent/apply_operations \
  -H "content-type: application/json" \
  -d '{
    "documentId": "my-document-id",
    "clientId": "agent-client-id",
    "operations": []
  }'

Use real Acuarela operations in the operations array.

Direct API flow:

1. Call get_basic_info.
2. Use create_document for a fresh canvas, or use the document id from the current Coview URL.
3. Read the current canvas with get_canvas_state.
4. Apply small, reviewable operation batches with apply_operations.
5. Call finish_working_on_nodes after editing.

Other access options:

- Remote MCP server: https://mcp.coview.dev/
- Document changes API: https://api.coview.dev/v1/documents/{documentId}/changes

More complete human documentation:

- /llms.txt gives short agent instructions embedded from the Coview home page.
- GET https://api.coview.dev/v1/agent gives the current machine-readable catalog.