# Clarity Copilot V2 API

**Canonical:** https://apis.io/apis/onclarity-com/onclarity-com-copilot-v2-api/  
**Provider:** Clarity — https://apis.io/providers/onclarity-com/  
**Base URL:** https://api.onclarity.com  
**Documentation:** https://api.onclarity.com

Clarity Copilot V2 API is one of 101 APIs that [Clarity](https://apis.io/providers/onclarity-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include copilot-v2. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The copilot-v2 API from Clarity — 41 operation(s) for copilot-v2.

## Operations (49)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/copilot-v2/library` | Get Library |
| PUT | `/api/v1/copilot-v2/pins` | Set Pins |
| GET | `/api/v1/copilot-v2/jobs` | Get Jobs |
| POST | `/api/v1/copilot-v2/jobs/seen` | Mark Jobs Seen |
| POST | `/api/v1/copilot-v2/jobs/dismissed` | Dismiss Jobs |
| POST | `/api/v1/copilot-v2/folders` | Create Folder |
| PATCH | `/api/v1/copilot-v2/folders/{folder_id}` | Rename Folder |
| DELETE | `/api/v1/copilot-v2/folders/{folder_id}` | Delete Folder |
| GET | `/api/v1/copilot-v2/prompts/deployed` | Get Deployed Prompt |
| GET | `/api/v1/copilot-v2/models` | List Model Choices |
| GET | `/api/v1/copilot-v2/prompts` | List Prompt Versions |
| POST | `/api/v1/copilot-v2/prompts` | Create Prompt Version |
| GET | `/api/v1/copilot-v2/prompts/{version_id}` | Get Prompt Version |
| DELETE | `/api/v1/copilot-v2/prompts/{version_id}` | Delete Prompt Version |
| GET | `/api/v1/copilot-v2/conversations` | List Page Conversations |
| POST | `/api/v1/copilot-v2/conversations` | Create Conversation |
| POST | `/api/v1/copilot-v2/warmups` | Start Warmup |
| GET | `/api/v1/copilot-v2/warmups/{warmup_id}` | Get Warmup Status |
| GET | `/api/v1/copilot-v2/conversations/by-session/{provider_session_id}` | Get Conversation By Session |
| GET | `/api/v1/copilot-v2/conversations/deleted` | List Deleted Conversations |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}` | Get Conversation |
| PATCH | `/api/v1/copilot-v2/conversations/{conversation_id}` | Update Conversation |
| DELETE | `/api/v1/copilot-v2/conversations/{conversation_id}` | Delete Conversation |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/interrupt` | Interrupt Conversation Turn |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/snapshots` | Get Conversation Snapshots |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/files` | Get Conversation Files |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/files/{artifact_id}` | Get Conversation File |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/files/{artifact_id}/content` | Get Conversation File Content |
| GET | `/api/v1/copilot-v2/project-users` | List Project Users |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/shares` | List Conversation Shares |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/shares` | Grant Conversation Shares |
| DELETE | `/api/v1/copilot-v2/conversations/{conversation_id}/shares/everyone` | Revoke Conversation Everyone Share |
| DELETE | `/api/v1/copilot-v2/conversations/{conversation_id}/shares/{user_id}` | Revoke Conversation Share |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/artifact-links` | Create Artifact Link |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/artifact-links` | List Artifact Links |
| DELETE | `/api/v1/copilot-v2/conversations/{conversation_id}/artifact-links/{artifact_id}` | Revoke Artifact Link |
| GET | `/api/v1/copilot-v2/shared/{token}` | Get Shared Artifact |
| GET | `/api/v1/copilot-v2/shared/{token}/content` | Get Shared Artifact Content |
| GET | `/api/v1/copilot-v2/html-artifacts/{artifact_id}` | Get Html Artifact |
| GET | `/api/v1/copilot-v2/report-figures/{artifact_id}` | Get Report Figure |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/uploads` | Upload Conversation File |
| DELETE | `/api/v1/copilot-v2/conversations/{conversation_id}/uploads/{resource_id}` | Delete Conversation Upload |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/forms/{tool_use_id}` | Submit Form |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/change-sets` | Append Change Set |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/change-sets/{change_set_id}/decision` | Decide Change Set |
| POST | `/api/v1/copilot-v2/conversations/{conversation_id}/change-sets/{change_set_id}/ack` | Acknowledge Change Set |
| GET | `/api/v1/copilot-v2/conversations/{conversation_id}/view` | Get Conversation View |
| POST | `/api/v1/copilot-v2` | Copilot V2 Chat |
| GET | `/api/v1/copilot-v2/health` | Copilot V2 Health |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-copilot-v2-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-dashboard-element-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-build-table-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-deeper-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-agent-response-schema.json

## Other Clarity APIs (12)

- [Clarity Accounts API](https://apis.io/apis/onclarity-com/onclarity-com-accounts-api/)
- [Clarity Admin API](https://apis.io/apis/onclarity-com/onclarity-com-admin-api/)
- [Clarity Agent Costs API](https://apis.io/apis/onclarity-com/onclarity-com-agent-costs-api/)
- [Clarity Agent Qa API](https://apis.io/apis/onclarity-com/onclarity-com-agent-qa-api/)
- [Clarity Agent Store Admin API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-admin-api/)
- [Clarity Agent Store API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-api/)
- [Clarity Agent Usage API](https://apis.io/apis/onclarity-com/onclarity-com-agent-usage-api/)
- [Clarity Anecdote Surveys API](https://apis.io/apis/onclarity-com/onclarity-com-anecdote-surveys-api/)
- [Clarity Anomalies API](https://apis.io/apis/onclarity-com/onclarity-com-anomalies-api/)
- [Clarity Asana API](https://apis.io/apis/onclarity-com/onclarity-com-asana-api/)
- [Clarity Bugs API](https://apis.io/apis/onclarity-com/onclarity-com-bugs-api/)
- [Clarity Classifications Admin API](https://apis.io/apis/onclarity-com/onclarity-com-classifications-admin-api/)

## Tags

copilot-v2

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/onclarity-com/onclarity-com-copilot-v2-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/onclarity-com/.