Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ASAPP Configuration API

Operations to manage ASAPP configurations

ASAPP Configuration API is one of 14 APIs that ASAPP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 8 paths. It is described by OpenAPI 3.0.1, at version 0.0.3.

Requests are made against a single base URL, https://api.sandbox.asapp.com.

17 operations 8 paths 0 schemas 3 DELETE8 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.3
Base URL
https://api.asapp.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

ASAPP Configuration API declares 2 security schemes for authenticating requests. An API key is passed in the header as asapp-api-id (API-ID). An API key is passed in the header as asapp-api-secret (API-Secret). By default, every request must be authenticated.

Paths & Operations 17

Across 8 paths, the API surfaces 17 operations — 3 DELETE, 8 GET, 2 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration 17

Operations to manage ASAPP configurations

GET
/configuration/v1/custom-vocabularies
List custom vocabularies
getCustomVocabularyConfigurations 2 params → 200400401403404409413422
POST
/configuration/v1/custom-vocabularies
Create a custom vocabulary
postCustomVocabularyConfiguration body → 201400401403404409413422
GET
/configuration/v1/custom-vocabularies/{customVocabularyId}
Retrieve a custom vocabulary
getCustomVocabularyConfiguration 1 param → 200400401403404409413422
DELETE
/configuration/v1/custom-vocabularies/{customVocabularyId}
Delete a custom vocabulary
deleteCustomVocabularyConfiguration 1 param → 200400401403404409413422
GET
/configuration/v1/redaction-entities
List redaction entities
listRedactionEntities 2 params → 200400401403404409413422
GET
/configuration/v1/redaction-entities/{entityId}
Retrieve a redaction entity
getRedactionEntity 1 param → 200400401403404409413422
PATCH
/configuration/v1/redaction-entities/{entityId}
Update a redaction entity
updateRedactionEntity 1 param body → 200400401403404409413422
GET
/configuration/v1/structured-data-fields
List structured data fields
getStructuredDataFields 3 params → 200400401403404409413422
POST
/configuration/v1/structured-data-fields
Create a structured data field
postStructuredDataField body → 201400401403404409413422
GET
/configuration/v1/structured-data-fields/{structuredDataFieldId}
Retrieve a structured data field
getStructuredDataField 1 param → 200400401403404409413422
PUT
/configuration/v1/structured-data-fields/{structuredDataFieldId}
Update a structured data field
putStructuredDataField 1 param body → 200400401403404409413422
DELETE
/configuration/v1/structured-data-fields/{structuredDataFieldId}
Delete a structured data field
deleteStructuredDataField 1 param → 200400401403404409413422
GET
/configuration/v1/segments
List segments
getSegments 2 params → 200400401403404409413422
POST
/configuration/v1/segments
Create a segment
postSegment body → 201400401403404409413422
GET
/configuration/v1/segments/{segmentId}
Retrieve a segment
getSegment 1 param → 200400401403404409413422
PATCH
/configuration/v1/segments/{segmentId}
Partial update a segment
patchSegment 1 param body → 200400401403404409413422
DELETE
/configuration/v1/segments/{segmentId}
Delete a segment
deleteSegment 1 param → 200400401403404409413422

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

asapp-configuration-api-openapi.yml Raw ↑

Other APIs ASAPP publishes across the network.

ASAPP AutoCompose API
ASAPP AutoSummary API
ASAPP AutoTranscribe API
ASAPP AutoTranscribe Media Gateway API
ASAPP Conversations API
ASAPP Disengage API
ASAPP Engage API
ASAPP File Exporter API
ASAPP GenerativeAgent API
ASAPP Health Check API
ASAPP Knowledge Base API
ASAPP Metadata API