Get conversation intent

curl --request GET \
  --url https://api.sandbox.asapp.com/autosummary/v1/intent/{conversationId} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'

{
  "conversationId": "<string>",
  "intent": {
    "code": "<string>",
    "name": "<string>"
  }
}

Intent

Get conversation intent

Retrieves the primary intent of a conversation, represented by both an intent code and a human-readable intent name. If no intent is detected, “NO_INTENT” is returned.

This endpoint requires:

Intent support to be explicitly enabled for your account.
A valid conversationId, which is an ASAPP-generated identifier created when using the ASAPP /conversations endpoint.

Use this endpoint to gain insights into the main purpose or topic of a conversation.

GET

autosummary

intent

{conversationId}

Get conversation intent

curl --request GET \
  --url https://api.sandbox.asapp.com/autosummary/v1/intent/{conversationId} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'

{
  "conversationId": "<string>",
  "intent": {
    "code": "<string>",
    "name": "<string>"
  }
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

conversationId

string

required

The identifier for a conversation.

Pattern: ^[A-Z0-9]+$

Response

Successfully generated intent.

conversationId

string

The id of the conversation.

intent

object

An object containing the determined intent for the conversation.

Show child attributes

Retrieve structured data Create conversation intent

⌘I

ASAPP APIs

Documentation Index

Authorizations

Path Parameters

Response