Vapi REST APIs Operations Index

All available Vapi REST APIs Operations

Metadata Authentication

Component

GET

Get Component Id Authentication Fingerprint

Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.

GET

Get Component Id Authentication

Retrieves authentication information about the component element corresponding to componentId. The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.

GET

List Metadata Authentication Component

Returns the identifiers for the component elements that have authentication information.

Package

GET

Get Package Id Authentication

Retrieves authentication information about the package element corresponding to packageId.

GET

List Metadata Authentication Package

Returns the identifiers for the package elements that have authentication information.

Service

GET

Get Service Id Authentication

Retrieves authentication information about the service element corresponding to serviceId.

GET

List Metadata Authentication Service

Returns the identifiers for the service elements that have authentication information.

Metadata Authentication Service

Operation

GET

Get Service Id Operation Id Authentication

Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

GET

List Service Id Authentication Operation

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

Metadata Cli

Command

GET

Get Cli Command Fingerprint

Returns the aggregate fingerprint of all the command metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

POST

Get Cli Command

Retrieves information about a command including information about how to execute that command.

GET

List Metadata Cli Command

Returns the identifiers of all commands, or commands in a specific namespace.

Namespace

GET

Get Cli Namespace Fingerprint

Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.

POST

Get Cli Namespace

Retreives information about a namespace including information about children of that namespace.

GET

List Metadata Cli Namespace

Returns the identifiers of all namespaces registered with the infrastructure.

Metadata Metamodel

Component

GET

Get Component Id Metamodel Fingerprint

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.

GET

Get Component Id Metamodel

Retrieves metamodel information about the component element corresponding to componentId. The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.

GET

List Metadata Metamodel Component

Returns the identifiers for the component elements that are registered with the infrastructure.

Enumeration

GET

Get Enumeration Id Metamodel

Retrieves information about the enumeration element corresponding to enumerationId. The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

GET

List Metadata Metamodel Enumeration

Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Metadata Identifier

Package

GET

Get Package Id Metamodel

Retrieves information about the package element corresponding to packageId.

GET

List Metadata Metamodel Package

Returns the identifiers for the packages elements that are contained in all the registered component elements.

Resource

GET

List Metadata Metamodel Resource

Returns the set of resource types present across all the service elements contained in all the package elements.

Service

GET

Get Service Id Metamodel

Retrieves information about the service element corresponding to serviceId. The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.

GET

List Metadata Metamodel Service

Returns the identifiers for the service elements that are currently registered with the infrastructure. The list of service elements is an aggregate list of all the service elements contained in all the package elements.

Structure

GET

Get Structure Id Metamodel

Retrieves information about the structure element corresponding to structureId. The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.

GET

List Metadata Metamodel Structure

Returns the identifiers for the structure elements that are contained in all the package elements and service elements.

Metadata Metamodel Resource

Model

GET

List Resource Id Metamodel Model

Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId. The Structure service provides operations to retrieve more details about the structure elements corresponding to the identifiers returned by this operation.

Metadata Metamodel Service

Operation

GET

Get Service Id Operation Id Metamodel

Retrieves the metamodel information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

GET

List Service Id Metamodel Operation

Returns the identifiers for the operation elements that are defined in the scope of serviceId.

Metadata Privilege

Component

GET

Get Component Id Privilege Fingerprint

Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.

GET

Get Component Id Privilege

Retrieves privilege information about the component element corresponding to componentId. The ComponentData contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.

GET

List Metadata Privilege Component

Returns the identifiers for the component elements that have privilege information.

Package

GET

Get Package Id Privilege

Retrieves privilege information about the package element corresponding to packageId.

GET

List Metadata Privilege Package

Returns the identifiers for the package elements that have privilege information.

Service

GET

Get Service Id Privilege

Retrieves privilege information about the service element corresponding to serviceId.

GET

List Metadata Privilege Service

Returns the identifiers for the service elements that have privilege information.

Metadata Privilege Service

Operation

GET

Get Service Id Operation Id Privilege

Retrieves the privilege information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

GET

List Service Id Privilege Operation

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have privilege information.