How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vitally Conversations API

The Conversations API from Vitally — 1 operation(s) for conversations.

Vitally Conversations API is one of 9 APIs that Vitally publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 2 base URLs: https://{subdomain}.rest.vitally.io/resources, https://rest.vitally-eu.io/resources.

2 operations 1 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://rest.vitally.io/resources
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Vitally Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Use your Vitally REST API key as the username with an empty password (Authorization: Basic base64(apiKey:)). Keys are created in the…

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 2
GET
/conversations
List conversations
listConversations 3 params → 200401
POST
/conversations
Create a conversation
createConversation body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GenericObject (6 properties), GenericWrite (5 properties), Error (1 property), Cursor (1 property). Each schema is shown below with its type and property counts.

Cursor
object
1 property
GenericWrite
object
5 properties
Error
object
1 property 1 required
GenericObject
object
Common Vitally object envelope. Every REST object exposes id, createdAt, updatedAt, externalId, name and a traits map; resource-specific fields are documented…
6 properties
ObjectList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vitally-conversations-api-openapi.yml Raw ↑

Other APIs Vitally publishes across the network.

Vitally Accounts API
Vitally Admins API
Vitally Custom Objects API
Vitally Notes API
Vitally NPS Responses API
Vitally Organizations API
Vitally Tasks API
Vitally Users API
Where this information came from

This is an independent, third-party profile of Vitally Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.