Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
intents
Get Intents
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "_id": "<string>",
      "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "OrderFood",
      "description": "Intent to order food",
      "tags": [
        "<string>"
      ],
      "isRejectIntent": true,
      "isDisabled": true,
      "localeReference": "<string>",
      "parentIntentId": "<string>",
      "feedbackReport": {
        "findings": [
          {
            "type": "poorFScore"
          }
        ],
        "info": {
          "fScore": 123
        }
      }
    }
  ],
  "total": 1,
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
flowId
string
required

The Id of the Flow

Required string length: 24

Query Parameters

​
filter
string

The name of the intent to filter the records

​
limit
integer

The maximum number of items to return. The default is 25.

Required range: 1 <= x <= 100
​
skip
integer

The number of items to skip. The default is 0. Used along with a limit of a pagination.

Required range: x >= 0
​
sort
string

The order of the sorting items-desc (descending) or asc (ascending). For example, to sort the records by name in ascending order, specify name:asc.

Minimum length: 1
​
next
string

This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination.

Required string length: 24
​
previous
string

This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination.

Required string length: 24
​
parent
string
Required string length: 24
​
includeChildren
boolean
​
includeFeedbackReport
boolean
​
preferredLocaleId
string
Required string length: 24

Response

Returns array of a Intents metadata objects

​
items
object[]
​
total
integer
Example:

1

​
next
string | null
Required string length: 24
​
previous
string | null
Required string length: 24