Vicero
Sign in

Endpoint reference

76 customer-facing endpoints, generated from the API's own schema — so this page cannot drift from what the server actually serves. Account, key and credential management, channel and automation plumbing, and platform operation are not listed here. Base path is /v1. See authentication for how to call them.

agents16

  • get/v1/agent-templates

    List Agent Templates

    org-scoped

  • get/v1/agents

    List Agents

    org-scoped

  • post/v1/agents

    Create Agent

    JSON body · org-scoped

  • get/v1/agents/{agent_id}

    Get Agent

    org-scoped

  • patch/v1/agents/{agent_id}

    Update Agent

    JSON body · org-scoped

  • delete/v1/agents/{agent_id}

    Delete Agent

    org-scoped

  • post/v1/agents/{agent_id}/duplicate

    Duplicate Agent

    org-scoped

  • post/v1/agents/{agent_id}/playground/chat

    Playground Chat

    JSON body · org-scoped

  • post/v1/agents/{agent_id}/rollback

    Rollback

    JSON body · org-scoped

  • get/v1/agents/{agent_id}/versions

    List Versions

    org-scoped

  • post/v1/agents/{agent_id}/versions

    Create Version

    org-scoped

  • patch/v1/agents/{agent_id}/versions/{number}

    Update Version

    JSON body · org-scoped

  • post/v1/agents/{agent_id}/versions/{number}/publish

    Publish Version

    org-scoped

  • get/v1/agents/{agent_id}/widget-config

    Get Widget Config

    org-scoped

  • patch/v1/agents/{agent_id}/widget-config

    Update Widget Config

    JSON body · org-scoped

  • post/v1/agents/{agent_id}/widget/logo

    Upload Widget Logo

    JSON body · org-scoped

analytics9

  • get/v1/analytics/agents

    Agent Performance

    2 query params · org-scoped

  • get/v1/analytics/by-agent

    By Agent

    3 query params · org-scoped

  • get/v1/analytics/export

    Export Csv

    5 query params · org-scoped

  • get/v1/analytics/latency

    Latency

    4 query params · org-scoped

  • get/v1/analytics/overview

    Overview

    4 query params · org-scoped

  • get/v1/analytics/series

    Series

    4 query params · org-scoped

  • get/v1/analytics/top-questions

    Top Questions

    4 query params · org-scoped

  • get/v1/analytics/unanswered

    Unanswered

    4 query params · org-scoped

  • get/v1/analytics/usage

    Usage

    5 query params · org-scoped

contacts6

  • get/v1/contacts

    List Contacts

    6 query params · org-scoped

  • post/v1/contacts

    Create Contact

    JSON body · org-scoped

  • get/v1/contacts/{contact_id}

    Get Contact

    org-scoped

  • patch/v1/contacts/{contact_id}

    Update Contact

    JSON body · org-scoped

  • patch/v1/contacts/{contact_id}/labels

    Set Labels

    JSON body · org-scoped

  • post/v1/contacts/{contact_id}/notes

    Add Note

    JSON body · org-scoped

conversations6

  • post/v1/agents/{agent_id}/chat

    Chat

    JSON body · org-scoped

  • get/v1/conversations

    List Conversations

    1 query param · org-scoped

  • get/v1/conversations/{cid}

    Get Conversation

    org-scoped

  • patch/v1/conversations/{cid}

    Update Conversation

    JSON body · org-scoped

  • delete/v1/conversations/{cid}

    Delete Conversation

    org-scoped

  • get/v1/conversations/{cid}/messages

    Get Messages

    org-scoped

inbox14

  • get/v1/inbox/attention

    Attention Queue

    org-scoped

  • get/v1/inbox/conversations

    List Conversations

    2 query params · org-scoped

  • get/v1/inbox/conversations/{cid}

    Get Detail

    org-scoped

  • post/v1/inbox/conversations/{cid}/assign

    Assign

    JSON body · org-scoped

  • post/v1/inbox/conversations/{cid}/attention/resolve

    Resolve Attention

    org-scoped

  • post/v1/inbox/conversations/{cid}/close

    Close

    org-scoped

  • post/v1/inbox/conversations/{cid}/handback

    Handback

    org-scoped

  • post/v1/inbox/conversations/{cid}/messages

    Reply

    JSON body · org-scoped

  • post/v1/inbox/conversations/{cid}/notes

    Add Note

    JSON body · org-scoped

  • post/v1/inbox/conversations/{cid}/tags

    Set Tags

    JSON body · org-scoped

  • post/v1/inbox/conversations/{cid}/takeover

    Takeover

    org-scoped

  • post/v1/inbox/conversations/{cid}/template

    Send Template

    JSON body · org-scoped

  • get/v1/inbox/workflow-approvals

    List Workflow Approvals

    org-scoped

  • post/v1/inbox/workflow-approvals/{handoff_id}/decide

    Decide Workflow Approval

    JSON body · org-scoped

knowledge13

  • get/v1/knowledge

    List Kbs

    org-scoped

  • post/v1/knowledge

    Create Kb

    JSON body · org-scoped

  • get/v1/knowledge/{kb_id}

    Get Kb

    org-scoped

  • patch/v1/knowledge/{kb_id}

    Update Kb

    JSON body · org-scoped

  • delete/v1/knowledge/{kb_id}

    Delete Kb

    org-scoped

  • get/v1/knowledge/{kb_id}/documents

    List Documents

    org-scoped

  • post/v1/knowledge/{kb_id}/documents

    Create Document

    JSON body · org-scoped

  • post/v1/knowledge/{kb_id}/documents/upload

    Upload Document

    JSON body · org-scoped

  • post/v1/knowledge/{kb_id}/search

    Search Kb

    JSON body · org-scoped

  • get/v1/knowledge/documents/{document_id}

    Get Document

    org-scoped

  • delete/v1/knowledge/documents/{document_id}

    Delete Document

    org-scoped

  • get/v1/knowledge/documents/{document_id}/chunks

    List Chunks

    org-scoped

  • post/v1/knowledge/documents/{document_id}/reingest

    Reingest Document

    org-scoped

public5

  • post/v1/public/agents/{public_key}/chat

    Public Chat

    JSON body

  • get/v1/public/agents/{public_key}/config

    Get Config

  • get/v1/public/agents/{public_key}/help

    List Help Articles

  • get/v1/public/agents/{public_key}/help/{slug}

    Get Help Article

  • get/v1/public/agents/{public_key}/widget-logo

    Get Widget Logo

webhooks7

  • get/v1/webhooks

    List Webhooks

    org-scoped

  • post/v1/webhooks

    Create Webhook

    JSON body · org-scoped

  • patch/v1/webhooks/{endpoint_id}

    Update Webhook

    JSON body · org-scoped

  • delete/v1/webhooks/{endpoint_id}

    Delete Webhook

    org-scoped

  • get/v1/webhooks/{endpoint_id}/deliveries

    List Deliveries

    org-scoped

  • post/v1/webhooks/{endpoint_id}/test

    Test Webhook

    org-scoped

  • get/v1/webhooks/events

    Event Catalog